IUIX_Dialog::GetItemSelParam Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 10: Line 10:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetItemSelParam([in]          BSTR      pItemID,
+
<pre class="brush:cpp;gutter:false">HRESULT GetItemSelParam([in]          BSTR      sItemID,
 
                         [in]          PARAM_T  nDef,
 
                         [in]          PARAM_T  nDef,
                         [out, retval]  PARAM_T*  pRes);</pre>
+
                         [out, retval]  PARAM_T*  nRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pItemID
+
;sItemID
 
:[in]  text ID of a required object in a dialog.
 
:[in]  text ID of a required object in a dialog.
 
;nDef
 
;nDef
:[in]  default value that will be returned in '''pRes''' value if no dialog object with a given ID was found.
+
:[in]  default value that will be returned in '''nRes''' value if no dialog object with a given ID was found.
;pRes
+
;nRes
 
:[out, retval]  return value of item parameter.
 
:[out, retval]  return value of item parameter.
  

Revision as of 04:18, 15 June 2015


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

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

Syntax

HRESULT GetItemSelParam([in]           BSTR      sItemID,
                        [in]           PARAM_T   nDef,
                        [out, retval]  PARAM_T*  nRes);

Parameters

sItemID
[in] text 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 operation was successful or error code in other cases.

See Also

IUIX_Dialog