IPXC_AcroForm::GetFieldByName Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}}
 
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}}
{{#parentPage:PXV:IPXC_AcroForm|GetFieldByName Method|method}}
+
{{#parentPage:PXV:IPXC_AcroForm#Methods|GetFieldByName Method|method}}
  
 
Retrieves the [[PXV:IPXC_FormField|field]] with the given name from a form.
 
Retrieves the [[PXV:IPXC_FormField|field]] with the given name from a form.

Revision as of 13:52, 21 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.

See Also

IPXC_AcroForm, IPXC_FormField.