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::AddVar method space
Adds a basic PDF form variable.

Note that first of all the semantically well defined addresses and structures should be preset before -if at all- the basic variables are set. Each generation/modification cycle ultimately ends with the display of the PDF form in Acrobat Reader. This is done under the assumption, that any missing and needed variable is inserted by the user directly. As a consequence there is no paradigm of "completeness" and "100% preset capability" requested and thus the setting of (semantically unknown) PDF variables is not compulsory.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequest/AddVar
[JSON input data] pIGeneralFormRequest:
bstrName:
bstrValue:		 longValue,    //interface address
"utf8StringValue",
"utf8StringValue"
[JSON result data] pbStatus: 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 AddVar( BSTR
BSTR
VARIANT_BOOL 		bstrName,
bstrValue,
*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 bstrName The PDF internal variable name/placeholder.

Use the iterator pair GetFirstVar / GetNextVar to retrieve all basic PDF form variable names, the semantical typification and the status (defined or undefined) defined by the currently load PDF form.
[in] BSTR bstrValue The value in string representation.

Caution:

  1. a Date value (VarType = enVarDate) MUST be supplied as a string representation of Microsoft DATE, not as a date coded string!
  2. a Boolean value (VarType = enVarBoolean) MUST as {'enYes' | '1' | 'true' | 'on'} for a true value, and as {'enNo' | '0' | 'false' | 'off'} for a false value!
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
space