IUIX_CmdHandler::OnGetItemState Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IUIX_CmdHandler::OnGetItemState Method}}
 
{{#customTitle:IUIX_CmdHandler::OnGetItemState Method}}
 
{{#parentPage:PXV:IUIX_CmdHandler#Methods|OnGetItemState|method}}
 
{{#parentPage:PXV:IUIX_CmdHandler#Methods|OnGetItemState|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets command's [[PXV:UIX_CmdItemState|state]].
  
 
== Syntax ==
 
== Syntax ==
Line 16: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;pCmd
 
;pCmd
:[in]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]].
+
:[in]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the source command.
 
;pItem
 
;pItem
:[in]  Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]].
+
:[in]  Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]] containing the source command item.
 
;pOwner
 
;pOwner
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] containing the owner object.
 
;nState
 
;nState
:[out]  Pointer to LONG.
+
:[out]  Pointer to LONG containing the resulting [[PXV:UIX_CmdItemState|state]].
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 02:22, 4 April 2016


Gets command's state.

Syntax

HRESULT OnGetItemState([in]   IUIX_Cmd*      pCmd,
                       [in]   IUIX_CmdItem*  pItem,
                       [in]   IUIX_Obj*      pOwner,
                       [out]  LONG*          nState);

Parameters

pCmd
[in] Pointer to IUIX_Cmd containing the source command.
pItem
[in] Pointer to IUIX_CmdItem containing the source command item.
pOwner
[in] Pointer to IUIX_Obj containing the owner object.
nState
[out] Pointer to LONG containing the resulting state.

Return Value

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

See Also

IUIX_CmdHandler