IPXC_AcroForm::GetFieldByName Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}} | {{#customTitle:IPXC_AcroForm::GetFieldByName Method}} | ||
| + | {{#parentPage:PXV:IPXC_AcroForm#Methods|GetFieldByName|method}} | ||
| − | + | Retrieves the [[PXV:IPXC_FormField|field]] with the given name from a form. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetFieldByName([in] LPWSTR sName, [out, retval] IPXC_FormField** ppField);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT GetFieldByName([in] LPWSTR sName, |
| + | [out, retval] IPXC_FormField** ppField);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;sName |
| − | :[in] | + | :[in] The name of the field to retrieve. |
| − | ; | + | ;ppField |
| − | :[out, retval] | + | :[out, retval] Pointer to a [[PXV:IPXC_FormField|IPXC_FormField]] variable that will receive the object of the field when the form contains a field with the specified name. |
== 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
Retrieves the field with the given name from a form.
Syntax
HRESULT GetFieldByName([in] LPWSTR sName,
[out, retval] IPXC_FormField** ppField);
Parameters
- sName
- [in] The name of the field to retrieve.
- ppField
- [out, retval] Pointer to a IPXC_FormField variable that will receive the object of the field when the form contains a field with the specified name.
Return Value
Returns S_OK if operation was successful or an error code in other cases.
