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


/images/arrow_right.png IGeneralFormRequest::GetFirstAddressRole method
Retrieves the first address of all semantically well defined address defined by the currently loaded PDF file.

Note, that basically the variable name/placeholder and the status (defined or not) is returned not an IAddress interface. Based on the returned status an address can be set or overwritten by the AddAddress method using the given bstrAddressName variable.

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

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstAddressRole( AddressRoleType
BSTR
long
long
YesNoType
VARIANT_BOOL 		*peAddressRole,
*pbstrAddressName,
*plIndex,
*plMaxOccurs,
*peIsDefined,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] AddressRoleType *peAddressRole The role type/typification of the address defined by the AddressRoleType enumerator.
[out] BSTR *pbstrAddressName The PDF internal variable name/placeholder onto which the address was mapped.
[out] long *plIndex The '0'-based index into the array of addresses of the given address role type.
[out] long *plMaxOccurs The maximal cardinality of this given address role type
[out] YesNoType *peIsDefined Boolean that designates if the address is already preset and 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.