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)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}}
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetBool Method|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetBool|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
Returns a boolean value of specified element of array. If specified element has not <code>PVT_BOOL</code> type, <code>nDefValue</code> returned.
+
Returns a boolean value of specified element of array. If specified element has not <code>PVT_Boolean</code> type, <code>bDefValue</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          nIndex,
                     [in, defaultvalue(0)]  VARIANT_BOOL  nDefValue,
+
                     [in, defaultvalue(0)]  VARIANT_BOOL  bDefValue,
                     [out, retval]          VARIANT_BOOL*  pVal);</pre>
+
                     [out, retval]          VARIANT_BOOL*  bVal);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nIndex
 
;nIndex
 
:[in] Specifies an index of the element in the array.
 
:[in] Specifies an index of the element in the array.
;nDefValue
+
;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.
 
:[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
+
;bVal
 
:[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>nDefValue</code> returned.
+
Returns S_OK if operation was successful or error code in other cases. Returns S_FALSE when <code>bDefValue</code> returned.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Latest revision as of 03:41, 15 June 2015

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.

See Also

IPXS_PDFVariant