IPXC_AcroForm::GetFieldByPDFObject Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}} | {{#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 == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetFieldByPDFObject([in] IPXS_PDFVariant* pVariant, [out, retval] IPXC_FormField** ppField);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT GetFieldByPDFObject([in] IPXS_PDFVariant* pVariant, |
| + | [out, retval] IPXC_FormField** ppField);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pVariant |
| − | :[in] | + | :[in] The [[PXV:IPXS_PDFVariant|pdf object]] of the field this method will look for. |
| − | ; | + | ;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 == | ||
| − | + | [[PXV:IPXC_AcroForm|IPXC_AcroForm]] | |
Latest revision as of 07:00, 23 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.
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.
