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 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetBool Method}}
{{#parentPage:PXV:IPXS_PDFVariant|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant|Arr_GetBool Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== 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>
+
<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 ==
 
== Parameters ==
;''nIndex''
+
;nIndex
 
:[in] Specifies an index of the element in the array.
 
:[in] Specifies an index of the element in the array.
;''nDefValue''
+
;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.
 
:[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''
+
;pVal
 
:[out, retval] Pointer to VARIANT_BOOL variable that receives returned value.
 
:[out, retval] Pointer to VARIANT_BOOL variable that receives returned value.
  

Revision as of 06:16, 23 April 2015


Returns a boolean value of specified element of array. If specified element has not PVT_BOOL type, nDefValue returned.

Syntax

HRESULT Arr_GetBool([in]                   ULONG          nIndex,
                    [in, defaultvalue(0)]  VARIANT_BOOL   nDefValue,
                    [out, retval]          VARIANT_BOOL*  pVal);

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 nDefValue returned.

See Also

See also IPXS_PDFVariant.