IUIX_Dialog::GetItemSelParam Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IUIX_Dialog::GetItemSelParam Method}} | {{#customTitle:IUIX_Dialog::GetItemSelParam Method}} | ||
{{#parentPage:PXV:IUIX_Dialog#Methods|GetItemSelParam|method}} | {{#parentPage:PXV:IUIX_Dialog#Methods|GetItemSelParam|method}} | ||
| − | + | ||
Gets ''parameter'' value of currently selected item in a list of a dialog object. | Gets ''parameter'' value of currently selected item in a list of a dialog object. | ||
| Line 10: | Line 10: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetItemSelParam([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT GetItemSelParam([in] BSTR sItemID, |
[in] PARAM_T nDef, | [in] PARAM_T nDef, | ||
| − | [out, retval] PARAM_T* | + | [out, retval] PARAM_T* nRes);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;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 ''' | + | :[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. | :[out, retval] return value of item parameter. | ||
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
[[PXV:IUIX_Dialog|IUIX_Dialog]] | [[PXV:IUIX_Dialog|IUIX_Dialog]] | ||
Latest revision as of 15: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 the operation was successful, or will return an error code if it fails.
