The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest450 COM module
IGeneralFormResult::GetFirstUnemployability method | |||
---|---|---|---|
Retrieves the first unemployability structure.
VARIANT_FALSE is returned if the end of the unemployability list is reached. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralFormResult/GetFirstUnemployability | ||
[JSON input data] | pIGeneralFormResult: | longValue, //interface address |
|
[JSON result data] | pbstrStructName: pdDate: pdBeginDate: pdEndDate: plPercentage: pbstrRemark: pbStatus: |
"utf8StringValue", "stringISODateValue", "stringISODateValue", "stringISODateValue", longValue, "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. | ||
C/C++ calling syntax | |||
HRESULT GetFirstUnemployability( | BSTR
DATE DATE DATE long BSTR VARIANT_BOOL |
*pbstrStructName,
*pdDate, *pdBeginDate, *pdEndDate, *plPercentage, *pbstrRemark, *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. | ||
Calling argument description | |||
[out] BSTR | *pbstrStructName | The PDF internal variable name/placeholder onto which the structure was mapped. | |
[out] DATE | *pdDate | The date when the unemployability record was created | |
[out] DATE | *pdBeginDate | The date when the unemployability starts | |
[out] DATE | *pdEndDate | The date when the unemployability ends. | |
[out] long | *plPercentage | The percentage of the unemployability supplied as a integer value in the interval [0,100]. | |
[out] BSTR | *pbstrRemark | An optional remark | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |