IPXC_AcroForm::GetFieldByPDFObject Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m |
||
| Line 2: | Line 2: | ||
{{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}} | {{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}} | ||
{{#parentPage:PXV:IPXC_AcroForm|GetFieldByPDFObject Method|method}} | {{#parentPage:PXV:IPXC_AcroForm|GetFieldByPDFObject Method|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 == | == Syntax == | ||
| Line 12: | Line 12: | ||
== Parameters == | == Parameters == | ||
;pVariant | ;pVariant | ||
| − | :[in] | + | :[in] The [[PXV:IPXS_PDFVariant|pdf object]] of the field this method will look for. |
;ppField | ;ppField | ||
| − | :[out, retval] | + | :[out, retval] Returns a [[PXV:IPXC_FormField|IPXC_FormField]] object if the specified form field was found or <tt>nullptr</tt> otherwise. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code in other cases. | + | Returns S_OK if operation was successful or an error code in other cases. |
== See Also == | == See Also == | ||
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]], [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]], [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]. | ||
Revision as of 06:22, 13 May 2015
Looks up and returns the field specified by its pdf object. If the specified pdf object is a widget's object, this method will return the form field to which that widget belongs.
Contents
Syntax
HRESULT GetFieldByPDFObject([in] IPXS_PDFVariant* pVariant,
[out, retval] IPXC_FormField** ppField);
Parameters
- pVariant
- [in] The pdf object of the field this method will look for.
- ppField
- [out, retval] Returns a IPXC_FormField object if the specified form field was found or nullptr otherwise.
Return Value
Returns S_OK if operation was successful or an error code in other cases.
See Also
See also IPXC_AcroForm, IPXC_FormField, IPXS_PDFVariant.
