IPXS_PDFVariant::Arr_GetNameA Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetNameA Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetNameA Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetNameA|method}} | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetNameA|method}} | ||
| − | |||
{{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. | |
== Syntax == | == Syntax == | ||
| Line 16: | Line 15: | ||
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
| − | :[in] | + | :[in] Specifies the index of the array element. |
;nDefValue | ;nDefValue | ||
| − | :[in] | + | :[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)] | + | :[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 | ;pVal | ||
| − | :[out, retval] | + | :[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 == | ||
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | ||
Revision as of 07:22, 29 May 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* pVal);
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.
- pVal
- [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.
