IUIX_Dialog::GetItemCheckState Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_Dialog::GetItemCheckState Method}} | {{#customTitle:IUIX_Dialog::GetItemCheckState Method}} | ||
| − | {{#parentPage:PXV:IUIX_Dialog#Methods|GetItemCheckState | + | {{#parentPage:PXV:IUIX_Dialog#Methods|GetItemCheckState|method}} |
| − | + | ||
Gets ''checked/unchecked'' state of a dialog item. | Gets ''checked/unchecked'' state of a dialog item. | ||
| Line 10: | Line 10: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetItemCheckState([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT GetItemCheckState([in] BSTR sItemID, |
| − | [out, retval] LONG* | + | [out, retval] LONG* nCheckState);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sItemID |
:[in] text ID of a required item. | :[in] text ID of a required item. | ||
| − | ; | + | ;nCheckState |
:[out, retval] returns TRUE if an item is in ''checked'' state, or FALSE otherwise. | :[out, retval] returns TRUE if an item is in ''checked'' state, or FALSE otherwise. | ||
== 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:13, 15 June 2015
Gets checked/unchecked state of a dialog item.
Used for items of IUIX_Label interface.
Syntax
HRESULT GetItemCheckState([in] BSTR sItemID,
[out, retval] LONG* nCheckState);
Parameters
- sItemID
- [in] text ID of a required item.
- nCheckState
- [out, retval] returns TRUE if an item is in checked state, or FALSE otherwise.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
