IPXC_AcroForm::GetFieldByName Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}}
 
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Retrieves a [[PXV:IPXV_FormField|field]] with a given name from a form..
  
 
== Syntax ==
 
== Syntax ==
Line 9: Line 9:
 
== Parameters ==
 
== Parameters ==
 
;''sName''
 
;''sName''
:[in] Value of LPWSTR.
+
:[in] Name of the field to retrieve.
 
;''ppField''
 
;''ppField''
:[out, retval] Pointer to [[PXV:IPXC_FormField|IPXC_FormField]].
+
:[out, retval] Pointer to [[PXV:IPXC_FormField|IPXC_FormField]] variable that will receive an object of the field when the form contains a field with specified name.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 17:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]].
+
See also [[PXV:IPXC_AcroForm|IPXC_AcroForm]], [[PXV:IPXC_FormField|IPXC_FormField]].

Revision as of 21:49, 12 April 2015

Retrieves a field with a given name from a form..

Syntax

HRESULT GetFieldByName([in] LPWSTR sName, [out, retval] IPXC_FormField** ppField);

Parameters

sName
[in] Name of the field to retrieve.
ppField
[out, retval] Pointer to IPXC_FormField variable that will receive an object of the field when the form contains a field with specified name.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IPXC_AcroForm, IPXC_FormField.