ICabNode::GetInt Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(13 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:ICabNode::GetInt Method}}
 
{{#customTitle:ICabNode::GetInt Method}}
 +
{{#parentPage:PXV:ICabNode#Methods|GetInt|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns the subnode value as a integer value (performing acceptable [[PXV:ICabNode:TypeConversions|type conversion]] if necessary).
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetInt([in, optional] BSTR pKey, [in, optional] INT defVal, [out, retval] INT* pVal);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetInt([in]                   LPWSTR  sKey,
 +
              [in, defaultvalue(0)] INT     nDefVal,
 +
              [out, retval]         INT*   nVal);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pKey''
+
;sKey
:[in, optional]  Value of BSTR.
+
:[in]  Value of LPWSTR.
;''defVal''
+
:Identifies a subnode. See [[PXV:CAB:SubnodeIdentification|CAB subnode identification syntax]].
:[in, optional]  Value of INT.
+
;nDefVal
;''pVal''
+
:[in, defaultvalue(0)]  Value of INT.
 +
:A value to be returned in case of error (subnode does not exist, has incompatible type etc.).
 +
;nVal
 
:[out, retval]  Pointer to INT.
 
:[out, retval]  Pointer to INT.
 
+
: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 ==
See also [[PXV:ICabNode|ICabNode]].
+
[[PXV:ICabNode|ICabNode]]

Latest revision as of 07:49, 15 June 2015


Returns the subnode value as a integer value (performing acceptable type conversion if necessary).

Syntax

HRESULT GetInt([in]                   LPWSTR  sKey,
               [in, defaultvalue(0)]  INT     nDefVal,
               [out, retval]          INT*    nVal);

Parameters

sKey
[in] Value of LPWSTR.
Identifies a subnode. See CAB subnode identification syntax.
nDefVal
[in, defaultvalue(0)] Value of INT.
A value to be returned in case of error (subnode does not exist, has incompatible type etc.).
nVal
[out, retval] Pointer to INT.
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.

See Also

ICabNode