IUIX_Dialog::GetItemSelParam2 Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Dialog::GetItemSelParam2 Method}}
 
{{#customTitle:IUIX_Dialog::GetItemSelParam2 Method}}
 +
{{#parentPage:PXV:IUIX_Dialog#Methods|GetItemSelParam2|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Gets ''parameter'' value of currently selected item in a list of a dialog object.
 +
 
 +
Dialog object is selected via its numerical ID and must implement [[PXV:IUIX_List|IUIX_List]], [[PXV:IUIX_Combo|IUIX_Combo]] or [[PXV:IUIX_Tree|IUIX_Tree]] interface.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetItemSelParam2([in] LONG nItemID, [in] ULONG_PTR nDef, [out, retval] ULONG_PTR* pRes);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetItemSelParam2([in]           LONG     nItemID,
 +
                        [in]           PARAM_T  nDef,
 +
                        [out, retval] PARAM_T* nRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nItemID''
+
;nItemID
:[in]  Value of LONG.
+
:[in]  numerical ID of a required object in a dialog.
;''nDef''
+
;nDef
:[in]  Value of ULONG_PTR.
+
:[in]  default value that will be returned in '''nRes''' value if no dialog object with a given ID was found.
;''pRes''
+
;nRes
:[out, retval]  Pointer to ULONG_PTR.
+
:[out, retval]  return value of item parameter.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Dialog|IUIX_Dialog]].
+
[[PXV:IUIX_Dialog|IUIX_Dialog]]

Latest revision as of 15:19, 15 June 2015


Gets parameter value of currently selected item in a list of a dialog object.

Dialog object is selected via its numerical ID and must implement IUIX_List, IUIX_Combo or IUIX_Tree interface.

Syntax

HRESULT GetItemSelParam2([in]           LONG      nItemID,
                         [in]           PARAM_T   nDef,
                         [out, retval]  PARAM_T*  nRes);

Parameters

nItemID
[in] numerical ID of a required object in a dialog.
nDef
[in] default value that will be returned in nRes value if no dialog object with a given ID was found.
nRes
[out, retval] return value of item parameter.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Dialog