View source for PXV:IPXC AcroForm GetFieldByPDFObject

__NOTOC__
[[Category:Editor]]
{{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}}
{{#parentPage:PXV:IPXC_AcroForm#Methods|GetFieldByPDFObject|method}}

Looks up and returns the [[PXV:IPXC_FormField|field]] specified by its [[PXV:IPXS_PDFVariant|pdf object]]. If the specified pdf object is a [[PXV:IPXC_Annotation|widget's]] object, this method will return the form field to which that widget belongs.

== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetFieldByPDFObject([in]           IPXS_PDFVariant*  pVariant,
                            [out, retval]  IPXC_FormField**  ppField);</pre>

== Parameters ==
;pVariant
:[in] The [[PXV:IPXS_PDFVariant|pdf object]] of the field this method will look for.
;ppField
:[out, retval] Returns a [[PXV:IPXC_FormField|IPXC_FormField]] object if the specified form field was found or <tt>nullptr</tt> otherwise.

== Return Value ==
Returns S_OK if operation was successful or an error code in other cases.

== See Also ==
[[PXV:IPXC_AcroForm|IPXC_AcroForm]]