IPXS_PDFVariant::Arr_GetBool Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 4: Line 4:
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetBool|method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetBool|method}}
  
−
Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code>bDefValue</code> returned.
+
Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code>DefValue</code> returned.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetBool([in]                  ULONG          nIndex,
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetBool([in]                  ULONG          Index,
−
                     [in, defaultvalue(0)]  VARIANT_BOOL  bDefValue,
+
                     [in, defaultvalue(0)]  VARIANT_BOOL  DefValue,
−
                     [out, retval]          VARIANT_BOOL*  bVal);</pre>
+
                     [out, retval]          VARIANT_BOOL*  Val);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;nIndex
+
;Index
 
:[in] Specifies an index of the element in the array.
 
:[in] Specifies an index of the element in the array.
−
;bDefValue
+
;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.
 
:[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
+
;Val
 
:[out, retval] Pointer to VARIANT_BOOL variable that receives returned value.
 
:[out, retval] Pointer to VARIANT_BOOL variable that receives returned value.
  
 
== Return Value ==
 
== Return Value ==
−
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>bDefValue</code> returned.
+
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>DefValue</code> returned.
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]
 
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Revision as of 06:17, 12 June 2015

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

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXS_PDFVariant_Arr_GetBool&oldid=42985"