API browser of acfValidator100 COM module


/images/arrow_right.png IValidateTMA::RunGrouper method space
Starts a grouping attempt for the specified sessionNumber or for all ACFBase elements if sessionNumber = -1.

Please note that this method performs various error checks before the actual grouping. These include ACFBase(sessionNumber) does not exist, no TMA services for given sessionNumber.

If a complete grouping is performed (sessionNumber = -1), then orphaned TMA services (services without ACFBase coupling) are also searched for.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IValidateTMA/RunGrouper
[JSON input data] pIValidateTMA:
lSessionNumber:
longValue,    //interface address
longValue
[JSON result data] pbstrGroupingStatusList:
pbStatus:
"utf8StringValue",
booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT RunGrouper( long
BSTR
VARIANT_BOOL
lSessionNumber,
*pbstrGroupingStatusList,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.
space
/images/arrow_right.png Calling argument description
[in] long lSessionNumber The ACFBase session number whose grouping is requested.
If session number is defined as -1, than the grouping takes place over all defined ACFBase elements.
[out] BSTR *pbstrGroupingStatusList A hash separated list of grouping states formatted as sessionNumber(ACFCode)# (e.g. 35(C08.26C) or 37(ERR_NO.amP) ). Note that the latter example shows the non-grouping result!
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string and value.
space