IPXC_AcroForm::GetFieldByName Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m |
||
| Line 2: | Line 2: | ||
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}} | {{#customTitle:IPXC_AcroForm::GetFieldByName Method}} | ||
{{#parentPage:PXV:IPXC_AcroForm|GetFieldByName Method|method}} | {{#parentPage:PXV:IPXC_AcroForm|GetFieldByName Method|method}} | ||
| − | |||
| − | Retrieves | + | |
| + | Retrieves the [[PXV:IPXC_FormField|field]] with the given name from a form. | ||
== Syntax == | == Syntax == | ||
| Line 12: | Line 12: | ||
== Parameters == | == Parameters == | ||
;sName | ;sName | ||
| − | :[in] | + | :[in] The name of the field to retrieve. |
;ppField | ;ppField | ||
| − | :[out, retval] Pointer to [[PXV:IPXC_FormField|IPXC_FormField]] variable that will receive | + | :[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 == | ||
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]]. | See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]]. | ||
Revision as of 05:49, 13 May 2015
Retrieves the field with the given name from a form.
Contents
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.
See Also
See also IPXC_AcroForm, IPXC_FormField.
