API browser of tarmedValidator100 COM module


/images/arrow_right.png ISearch::SearchServiceBlock method space
This method searches for services which belong to the base service block.
Patched to get service block, group, and gender relevance information
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearch/SearchServiceBlock
[JSON input data] pISearch:
bstrBlockCode:
eOnlyMainServices:
longValue,    //interface address
"utf8StringValue",
longValue
[JSON result data] pbStatus: 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 SearchServiceBlock( BSTR
YesNoType
VARIANT_BOOL
bstrBlockCode,
eOnlyMainServices,
*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] BSTR bstrBlockCode Service block code.
Patch: the parameter can be appended with
  • #SB to retrieve the service block numbers
    and/or
  • #SG to retrieve the service group numbers
    and/or
  • #SEX to retrieve the gender relevance, where the possible codes are: 0=not relevant; 1=male only; 2=female only
cf. ISearch::SearchCode for an example
[in] YesNoType eOnlyMainServices Flag specifying whether to search for main services only. Main services mean services which are not subsidiary to any other service, i.e. base services.
[out,retval] VARIANT_BOOL *pbStatus Return status. VARIANT_TRUE means S_OK, VARIANT_FALSE means S_FALSE (e.g. in an iterator) or an error (E_name).
In the later case check for possible errors with the GetAbortInfo method.
space