IPXS_PDFVariant::Arr_GetName Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetName Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetName Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetName|method}} | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetName|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | The | + | The Returns the value of a specified element of an array as an unicode string ('''BSTR'''). If specified element type is not <code>PVT_Name</code> <code>pDefVal</code> is returned. |
== Syntax == | == Syntax == | ||
| Line 15: | Line 14: | ||
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
| − | :[in] | + | :[in] Specifies the index of the array element. |
;pDefVal | ;pDefVal | ||
| − | :[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>. |
;ppVal | ;ppVal | ||
| − | :[out, retval] Pointer to BSTR. | + | :[out, retval] Pointer to BSTR that receives the returned value. |
== 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>pDefVal</code> returned. |
| + | |||
== See Also == | == See Also == | ||
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] | ||
Revision as of 06:38, 29 May 2015
The Returns the value of a specified element of an array as an unicode string (BSTR). If specified element type is not PVT_Name pDefVal is returned.
Syntax
HRESULT Arr_GetName([in] ULONG nIndex,
[in] BSTR pDefVal,
[out, retval] BSTR* ppVal);
Parameters
- nIndex
- [in] Specifies the index of the array element.
- pDefVal
- [in] Default value that will be returned when specified index is out of range or the element type is not
PVT_Name. - ppVal
- [out, retval] Pointer to BSTR that receives the returned value.
Return Value
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when pDefVal returned.
