IPXS_PDFVariant::Arr_GetName Method

From PDF XChange PDF SDK
Revision as of 03:42, 15 June 2015 by Dsbot (Talk | contribs) (Automatic page editing by robot)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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 sDefVal is returned.

Syntax

HRESULT Arr_GetName([in]           ULONG  nIndex,
                    [in]           BSTR   sDefVal,
                    [out, retval]  BSTR*  sVal);

Parameters

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

See Also

IPXS_PDFVariant