IPXS_PDFVariant::Arr_GetNameA Method
From PDF XChange PDF SDK
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> | + | 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 | + | <pre class="brush:cpp;gutter:false">HRESULT Arr_GetNameA([in] ULONG nIndex, |
| − | [in] ULONG | + | [in] ULONG nDefValue, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL bAddAtom, |
| − | [out, retval] ULONG* | + | [out, retval] ULONG* nVal);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;nIndex |
:[in] Specifies the index of the array element. | :[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 <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 |
:[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 |
:[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> | + | 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 == | ||
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | ||
Latest revision as of 02:42, 15 June 2015
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.
