API browser of tarmedValidator100 COM module


/images/arrow_right.png IUtility::GetFirstExpandRecord method space
Gets the first expanded record.
 
PATCH:
If the instruction #INFO is appened to the service code in Expand("aCode#INFO",...) than the "non-expandable, dropped" fraction too large for a full expansion under the current rule regime is returned in *pbstrCode.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IUtility/GetFirstExpandRecord
[JSON input data] pIUtility: longValue,    //interface address
[JSON result data] pbstrCode:
pbstrReferenceCode:
pdQuantity:
plID:
pbStatus:
"utf8StringValue",
"utf8StringValue",
doubleValue,
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 GetFirstExpandRecord( BSTR
BSTR
double
long
VARIANT_BOOL
*pbstrCode,
*pbstrReferenceCode,
*pdQuantity,
*plID,
*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 *pbstrCode Tarmed service code.
 
Patch: after expanding IUtility::Expand("00.0010#INFO",23,) under "paper limits", the returned service code is "00.0010#INFO3" meaning that 3 min out of 23 min are not applicable (aka dropped) within the current TarMed rule set regime.
[out] BSTR *pbstrReferenceCode Reference code
[out] double *pdQuantity Quantity value.
[out] long *plID Some services can expand with more then one slave service, all services with the same ID are possible expansion pairs.
[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