IPXS_PDFVariant::Arr_GetNameA Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetNameA Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetNameA Method}}
 +
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetNameA|method}}
 +
{{ToReview}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
Returns the value of a specified element of an array as an PDF atom. If specified element type is not <code>PVT_Name</code> <code>nDefValue</code> is returned. If <code>bAddAtom</code> is '''false''' and name does not have corresponding atom '''0''' will be retuned.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetNameA([in] ULONG nIndex, [in] ULONG nDefValue, [in, defaultvalue(0)] VARIANT_BOOL bAddAtom, [out, retval] ULONG* pVal);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetNameA([in]                   ULONG         nIndex,
 +
                    [in]                   ULONG         nDefValue,
 +
                    [in, defaultvalue(0)] VARIANT_BOOL bAddAtom,
 +
                    [out, retval]         ULONG*       nVal);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''nIndex''
+
;nIndex
−
:[in] Value of ULONG.
+
:[in] Specifies the index of the array element.
−
;''nDefValue''
+
;nDefValue
−
:[in] Value of ULONG.
+
:[in] Default value that will be returned when specified index is out of range or the element type is not <code>PVT_Name</code>.
−
;''bAddAtom''
+
;bAddAtom
−
:[in, defaultvalue(0)] Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)] This value control will we add new atom or not when corresponding atom does not exist. Most usable PDF names already has built-in corresponding atoms, and you always may register your own atoms for frequently used names.
−
;''pVal''
+
;nVal
−
:[out, retval] Pointer to ULONG.
+
:[out, retval] Pointer to ULONG that receives the returned atom.
  
 
== 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 error code in other cases. Returns S_FALSE when <code>nDefValue</code> returned.
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Latest revision as of 03:42, 15 June 2015

PDF Structures Layer > Interfaces > IPXS_PDFVariant > IPXS_PDFVariant::Arr_GetNameA Method


Returns the value of a specified element of an array as an PDF atom. If specified element type is not PVT_Name nDefValue is returned. If bAddAtom is false and name does not have corresponding atom 0 will be retuned.

Syntax

HRESULT Arr_GetNameA([in]                   ULONG         nIndex,
                     [in]                   ULONG         nDefValue,
                     [in, defaultvalue(0)]  VARIANT_BOOL  bAddAtom,
                     [out, retval]          ULONG*        nVal);

Parameters

nIndex
[in] Specifies the index of the array element.
nDefValue
[in] Default value that will be returned when specified index is out of range or the element type is not PVT_Name.
bAddAtom
[in, defaultvalue(0)] This value control will we add new atom or not when corresponding atom does not exist. Most usable PDF names already has built-in corresponding atoms, and you always may register your own atoms for frequently used names.
nVal
[out, retval] Pointer to ULONG that receives the returned atom.

Return Value

Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when nDefValue returned.

See Also

IPXS_PDFVariant

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXS_PDFVariant_Arr_GetNameA&oldid=45362"