IPXC_AcroForm::GetFieldByPDFObject Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetFieldByPDFObject([in] IPXS_PDFVariant* pVariant, [out, retval] IPXC_FormField** ppField);</pre>
+
<pre class="brush:cpp">HRESULT GetFieldByPDFObject([in] IPXS_PDFVariant* pVariant, [out, retval] IPXC_FormField** ppField);</pre>
  
 
== Parameters ==
 
== Parameters ==

Revision as of 12:13, 16 April 2015

Look up and returns a field specified by its pdf object. If specified pdf object is widget's object, this method will return form field whose that widget is.

Syntax

HRESULT GetFieldByPDFObject([in] IPXS_PDFVariant* pVariant, [out, retval] IPXC_FormField** ppField);

Parameters

pVariant
[in] A pdf object of the field method will look for.
ppField
[out, retval] An IPXC_FormField object if form field was found or nullptr otherwise.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IPXC_AcroForm, IPXC_FormField, IPXS_PDFVariant.