IPXC_AcroForm::GetFieldByPDFObject Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 2: Line 2:
 
{{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}}
 
{{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Look up and returns a [[PXV:IPXC_FormField|field]] specified by its [[PXV:IPXS_PDFVariant|pdf object]]. If specified pdf object is [[PXV:IPXC_Annotation|widget's]] object, this method will return form field whose that widget is.
  
 
== Syntax ==
 
== Syntax ==
Line 9: Line 9:
 
== Parameters ==
 
== Parameters ==
 
;''pVariant''
 
;''pVariant''
:[in] Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
:[in] A [[PXV:IPXS_PDFVariant|pdf object]] of the field method will look for.
 
;''ppField''
 
;''ppField''
:[out, retval] Pointer to [[PXV:IPXC_FormField|IPXC_FormField]].
+
:[out, retval] An [[PXV:IPXC_FormField|IPXC_FormField]] object if form field was found or <tt>nullptr</tt> otherwise.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 17:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]].
+
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]], [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].

Revision as of 10:28, 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.