IUIX_Dialog::SetItemCueText2 Method

Latest revision as of 14:41, 15 June 2015

UI Layer > Interfaces > IUIX_Dialog > IUIX_Dialog::SetItemCueText2 Method

Sets cue text of a required item by its numerical ID. The item must implement IUIX_Edit interface.

Cue text is displayed in grey color when there is no other text in the item.

HRESULT SetItemCueText2([in]  LONG  nItemID,
                        [in]  BSTR  sText);

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IUIX_Dialog::SetItemCueText2 Method}}
-{{#parentPage:PXV:IUIX_Dialog|SetItemCueText2 Method|method}}
+{{#parentPage:PXV:IUIX_Dialog#Methods|SetItemCueText2|method}}
-{{ToReview}}
-Sets ''cue text'' for a required item. The item must implement [[PXV:IUIX_Edit|IUIX_Edit]] interface.
-Cue text is displayed in grey color when there is no other text in item.
+Sets ''cue text'' of a required item by its numerical ID. The item must implement [[PXV:IUIX_Edit|IUIX_Edit]] interface.
+Cue text is displayed in grey color when there is no other text in the item.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT SetItemCueText2([in]  LONG  pItemID,
+<pre class="brush:cpp;gutter:false">HRESULT SetItemCueText2([in]  LONG  nItemID,
-                         [in]  BSTR  pText);</pre>
+                         [in]  BSTR  sText);</pre>
 == Parameters ==
-;pItemID
+;nItemID
 :[in]  numerical ID of a required item.
-;pText
+;sText
 :[in]  ''cue text'' to display in the item.
 == 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 [[PXV:IUIX_Dialog|IUIX_Dialog]].
+[[PXV:IUIX_Dialog|IUIX_Dialog]]