IPXS_PDFVariant::Arr_GetString Method

PDF Structures Layer > Interfaces > IPXS_PDFVariant > IPXS_PDFVariant::Arr_GetString Method

The Returns the value of a specified element of an array as an unicode string (BSTR). If specified element type is not PVT_String sDefVal is returned.

Syntax

HRESULT Arr_GetString([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_String.

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.

See Also

IPXS_PDFVariant