IPXC_AcroForm::GetFieldByPDFObject Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 1: | Line 1: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}} | {{#customTitle:IPXC_AcroForm::GetFieldByPDFObject Method}} | ||
| − | {{#parentPage:PXV:IPXC_AcroForm|method}} | + | {{#parentPage:PXV:IPXC_AcroForm|GetFieldByPDFObject Method|method}} |
{{ToReview}} | {{ToReview}} | ||
| Line 7: | Line 7: | ||
== 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] A [[PXV:IPXS_PDFVariant|pdf object]] of the field method will look for. | :[in] A [[PXV:IPXS_PDFVariant|pdf object]] of the field method will look for. | ||
| − | ; | + | ;ppField |
:[out, retval] An [[PXV:IPXC_FormField|IPXC_FormField]] object if form field was found or <tt>nullptr</tt> otherwise. | :[out, retval] An [[PXV:IPXC_FormField|IPXC_FormField]] object if form field was found or <tt>nullptr</tt> otherwise. | ||
Revision as of 04:54, 23 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.
Contents
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.
