IPXS_PDFVariant::Arr_GetBool Method
From PDF XChange PDF SDK
Returns a boolean value of specified element of array. If specified element has not PVT_Boolean
type, bDefValue
returned.
Syntax
HRESULT Arr_GetBool([in] ULONG nIndex, [in, defaultvalue(0)] VARIANT_BOOL bDefValue, [out, retval] VARIANT_BOOL* bVal);
Parameters
- nIndex
- [in] Specifies an index of the element in the array.
- bDefValue
- [in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value.
- bVal
- [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 bDefValue
returned.