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)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
−
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.
+
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>DefValue</code> is returned. If <code>AddAtom</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,
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetNameA([in]                  ULONG        Index,
−
                     [in]                  ULONG        nDefValue,
+
                     [in]                  ULONG        DefValue,
−
                     [in, defaultvalue(0)]  VARIANT_BOOL  bAddAtom,
+
                     [in, defaultvalue(0)]  VARIANT_BOOL  AddAtom,
−
                     [out, retval]          ULONG*        nVal);</pre>
+
                     [out, retval]          ULONG*        Val);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;nIndex
+
;Index
 
:[in] Specifies the index of the array element.
 
:[in] Specifies the index of the array element.
−
;nDefValue
+
;DefValue
 
:[in] Default value that will be returned when specified index is out of range or the element type is not <code>PVT_Name</code>.
 
:[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
+
;AddAtom
 
:[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.
 
:[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
+
;Val
 
:[out, retval] Pointer to ULONG that receives the returned atom.
 
:[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_FALSE when <code>nDefValue</code> returned.
+
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>DefValue</code> returned.
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]
 
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Revision as of 07:18, 12 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 DefValue is returned. If AddAtom is false and name does not have corresponding atom 0 will be retuned.

Syntax

HRESULT Arr_GetNameA([in]                   ULONG         Index,
                     [in]                   ULONG         DefValue,
                     [in, defaultvalue(0)]  VARIANT_BOOL  AddAtom,
                     [out, retval]          ULONG*        Val);

Parameters

Index
[in] Specifies the index of the array element.
DefValue
[in] Default value that will be returned when specified index is out of range or the element type is not PVT_Name.
AddAtom
[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.
Val
[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 DefValue returned.

See Also

IPXS_PDFVariant

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