View source for PXV:IPXS PDFVariant Arr GetBool

__NOTOC__
[[Category:Editor]]
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}}
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetBool Method|method}}

Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code>nDefValue</code> returned.

== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetBool([in]                   ULONG          nIndex,
                    [in, defaultvalue(0)]  VARIANT_BOOL   nDefValue,
                    [out, retval]          VARIANT_BOOL*  pVal);</pre>

== Parameters ==
;nIndex
:[in] Specifies an index of the element in the array.
;nDefValue
:[in, defaultvalue(0)] Default value that will be returned when specified index is out of range or the element is not a boolean value.
;pVal
:[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 <code>nDefValue</code> returned.

== See Also ==
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].