IPXS_PDFVariant::Arr_GetBool Method

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

Returns a boolean value of specified element of array. If specified element has not PVT_Boolean type, DefValue returned.

Syntax

HRESULT Arr_GetBool([in]                   ULONG          Index,
                    [in, defaultvalue(0)]  VARIANT_BOOL   DefValue,
                    [out, retval]          VARIANT_BOOL*  Val);

Parameters

Index

[in] Specifies an index of the element in the array.

DefValue

[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value.

Val

[out, retval] Pointer to VARIANT_BOOL variable that receives returned value.

Return Value

Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when DefValue returned.

See Also

IPXS_PDFVariant