IPXS_PDFVariant::Arr_GetName Method

From PDF XChange PDF SDK
Revision as of 07:38, 29 May 2015 by Lzcat (Talk | contribs)

Jump to: navigation, search


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.


See Also

IPXS_PDFVariant