API browser of tardocValidator100 COM module


/images/arrow_right.png IUtility::Expand method space
Expands the given main code, according to the supplied number and as multiples of the base unit.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IUtility/Expand
[JSON input data] pIUtility:
bstrCode:
dNumber:
dDate:
eRespectQuantityLimits:
longValue,    //interface address
"utf8StringValue",
doubleValue,
variantDateValue | "stringISODateValue",
longValue
[JSON result data] pdRemainingNumber:
pbStatus:
doubleValue,
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 Expand( BSTR
double
DATE
YesNoType
double
VARIANT_BOOL
bstrCode,
dNumber,
dDate,
eRespectQuantityLimits,
*pdRemainingNumber,
*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 bstrCode Tardoc base service code to expand.
[in] double dNumber Number supplied as multiples of the base unit.
For example if a consultation lasted 17 Minutes, 17 would be entered.
 
The base unit information for the code can be retrieved from the ISearch::GetUnit property interface.
[in] DATE dDate Date of the service.
[in] YesNoType eRespectQuantityLimits Set to `enYes` to enforce quantity limitations during expansion, or `enNo` to bypass.
[out] double *pdRemainingNumber Receives the remaining quantity after applying limit rules (only meaningful if quantity limits were respected).
[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