API browser of tarmedValidator100 COM module


/images/arrow_right.png ISearch::FindNextDescendant method space
Method to find any services that are descendants of a base service using a recursive-decent approach.
 
The crawling is initiated by the FindDescendant method.
 
PATCH to restrict the result space to services that are not 123 aka "First-Next-Last" type services, call FindDescendant("aCode#no123TypeService",...) in the first place.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearch/FindNextDescendant
[JSON input data] pISearch: longValue,    //interface address
[JSON result data] pbstrDescendantCode:
pbstrDescendantReference:
plLevel:
pbStatus:
"utf8StringValue",
"utf8StringValue",
longValue,
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 FindNextDescendant( BSTR
BSTR
long
VARIANT_BOOL
*pbstrDescendantCode,
*pbstrDescendantReference,
*plLevel,
*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
[out] BSTR *pbstrDescendantCode Descendant service code.
[out] BSTR *pbstrDescendantReference Immediate parent reference code of the descendant service.
[out] long *plLevel The nesting level of the descendant service code.
[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