IPXS_PDFVariant::Arr_GetName Method

From PDF XChange PDF SDK
Revision as of 07:18, 12 June 2015 by Dsbot (Talk | contribs) (Automatic page editing by robot)

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 DefVal is returned.

Syntax

HRESULT Arr_GetName([in]           ULONG  Index,
                    [in]           BSTR   DefVal,
                    [out, retval]  BSTR*  Val);

Parameters

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

See Also

IPXS_PDFVariant