The generalFormRequest ATL COM module manages
and fills out a PDF based form system
API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormRequest::GetNextVar method space
Retrieves the next basic PDF form variable.

VARIANT_FALSE is returned if the end of the variable list is reached.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequest/GetNextVar
[JSON input data] pIGeneralFormRequest: longValue,    //interface address
[JSON result data] peVarType:
pbstrName:
pbstrValue:
pbstrEnumList:
peIsDefined:
pbStatus:		 longValue,
"utf8StringValue",
"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 GetNextVar( VarType
BSTR
BSTR
BSTR
YesNoType
VARIANT_BOOL 		*peVarType,
*pbstrName,
*pbstrValue,
*pbstrEnumList,
*peIsDefined,
*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] VarType *peVarType The basic data type of the variable defined by the VarType enumerator.
[out] BSTR *pbstrName The PDF internal variable name/placeholder.
[out] BSTR *pbstrValue The value in string representation. If the value is undefined, then bstrValue is empty.

Caution:

  1. a Date value (VarType = enVarDate) is supplied as a string representation of Microsoft DATE, not as a date coded string!
  2. a Boolean value (VarType = enVarBoolean) is returned as {'enYes' | 'enNo' ).
[out] BSTR *pbstrEnumList If eVarType=enVarEnumeration then bstrEnumList is the '#' separated list of all allowed tokens otherwise bstrEnumList is empty.
[out] YesNoType *peIsDefined A Boolean designating if the value is defined (enYes) or not (enNo).
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
space