IUIX_Dialog::GetItemSelParam Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Dialog::GetItemSelParam Method}}
 
{{#customTitle:IUIX_Dialog::GetItemSelParam Method}}
 
{{#parentPage:PXV:IUIX_Dialog|GetItemSelParam Method|method}}
 
{{#parentPage:PXV:IUIX_Dialog|GetItemSelParam Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
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 text ID and must implement [[PXV:IUIX_List|IUIX_List]], [[PXV:IUIX_Combo|IUIX_Combo]] or [[PXV:IUIX_Tree|IUIX_Tree]] interface.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;pItemID
 
;pItemID
:[in]  Value of BSTR.
+
:[in]  text ID of a required object in a dialog.
 
;nDef
 
;nDef
:[in]  Value of PARAM_T.
+
:[in]  default value that will be returned in '''pRes''' value if no dialog object with a given ID was found.
 
;pRes
 
;pRes
:[out, retval]  Pointer to PARAM_T.
+
:[out, retval]  return value of item parameter.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 07:28, 16 May 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      pItemID,
                        [in]           PARAM_T   nDef,
                        [out, retval]  PARAM_T*  pRes);

Parameters

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

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IUIX_Dialog.