API browser of generalFormRequest430 COM module


/images/arrow_right.png IGeneralFormRequest::GetFirstVar method
Retrieves the first basic PDF form variable.

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

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstVar( VarType
BSTR
BSTR
BSTR
YesNoType
VARIANT_BOOL
*peVarType,
*pbstrName,
*pbstrValue,
*pbstrEnumList,
*peIsDefined,
*pbStatus);
 
/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
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
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.