ICabNode::GetBool Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:ICabNode::GetBool Method}} | {{#customTitle:ICabNode::GetBool Method}} | ||
| + | {{#parentPage:PXV:ICabNode#Methods|GetBool|method}} | ||
| + | {{ToWrite}} | ||
| + | {{ToReview}} | ||
| − | + | Returns the subnode value as a Boolean value (performing acceptable [[PXV:ICabNode:TypeConversions|type conversion]] if necessary). | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetBool([in | + | <pre class="brush:cpp;gutter:false">HRESULT GetBool([in] LPWSTR sKey, |
| + | [in, defaultvalue(0)] VARIANT_BOOL bDefVal, | ||
| + | [out, retval] VARIANT_BOOL* bVal);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;sKey |
| − | :[in | + | :[in] Value of LPWSTR. |
| − | ; | + | :Identifies a subnode. See [[PXV:CAB:SubnodeIdentification|CAB subnode identification syntax]]. |
| − | :[in, | + | ;bDefVal |
| − | ; | + | :[in, defaultvalue(0)] Value of VARIANT_BOOL. |
| + | :A value to be returned in case of error (subnode does not exist, has incompatible type etc.). | ||
| + | ;bVal | ||
:[out, retval] Pointer to VARIANT_BOOL. | :[out, retval] Pointer to VARIANT_BOOL. | ||
| − | + | :The address of a variable that receives a referenced subnode value. | |
== Return Value == | == Return Value == | ||
Returns S_OK if operation was successful or error code in other cases. | Returns S_OK if operation was successful or error code in other cases. | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:ICabNode|ICabNode]] | |
Latest revision as of 07:53, 15 June 2015
Returns the subnode value as a Boolean value (performing acceptable type conversion if necessary).
Syntax
HRESULT GetBool([in] LPWSTR sKey,
[in, defaultvalue(0)] VARIANT_BOOL bDefVal,
[out, retval] VARIANT_BOOL* bVal);
Parameters
- sKey
- [in] Value of LPWSTR.
- Identifies a subnode. See CAB subnode identification syntax.
- bDefVal
- [in, defaultvalue(0)] Value of VARIANT_BOOL.
- A value to be returned in case of error (subnode does not exist, has incompatible type etc.).
- bVal
- [out, retval] Pointer to VARIANT_BOOL.
- The address of a variable that receives a referenced subnode value.
Return Value
Returns S_OK if operation was successful or error code in other cases.
