IPXC_AcroForm::GetFieldByName Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}}
 
{{#customTitle:IPXC_AcroForm::GetFieldByName Method}}
{{#parentPage:PXV:IPXC_AcroForm|method}}
+
{{#parentPage:PXV:IPXC_AcroForm|GetFieldByName Method|method}}
 
{{ToReview}}
 
{{ToReview}}
  
Line 7: Line 7:
  
 
== 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''
+
;sName
 
:[in] Name of the field to retrieve.
 
:[in] Name of the field to retrieve.
;''ppField''
+
;ppField
 
:[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.
 
:[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.
  

Revision as of 05:54, 23 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.