IUIX_Dialog::GetItemCheckState Method

Latest revision as of 15:13, 15 June 2015

UI Layer > Interfaces > IUIX_Dialog > IUIX_Dialog::GetItemCheckState Method

Gets checked/unchecked state of a dialog item.

Used for items of IUIX_Label interface.

HRESULT GetItemCheckState([in]           BSTR   sItemID,
                          [out, retval]  LONG*  nCheckState);

sItemID: [in] text ID of a required item.
nCheckState: [out, retval] returns TRUE if an item is in checked state, or FALSE otherwise.

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::GetItemCheckState Method}}
-{{#parentPage:PXV:IUIX_Dialog|method}}
+{{#parentPage:PXV:IUIX_Dialog#Methods|GetItemCheckState|method}}
-{{ToWrite}}
-{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets ''checked/unchecked'' state of a dialog item.
+Used for items of [[PXV:IUIX_Label|IUIX_Label]] interface.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT GetItemCheckState([in] BSTR pItemID, [out, retval] LONG* pCheckState);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT GetItemCheckState([in]           BSTR   sItemID,
+                          [out, retval]  LONG*  nCheckState);</pre>
 == Parameters ==
-;''pItemID''
+;sItemID
-:[in]  Value of BSTR.
+:[in]  text ID of a required item.
-;''pCheckState''
+;nCheckState
-:[out, retval]  Pointer to LONG.
+:[out, retval]  returns TRUE if an item is in ''checked'' state, or FALSE otherwise.
 == 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]]