IUIX_Inst::CreateCmdPane Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateCmdPane Method}}
 
{{#customTitle:IUIX_Inst::CreateCmdPane Method}}
 +
{{#parentPage:PXV:IUIX_Inst#Methods|CreateCmdPane|method}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new object of [[PXV:IUIX_CmdPane|IUIX_CmdPane]] interface.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT CreateCmdPane([in] IUIX_Obj* pParent, [in] RECT* pRect, [in] LONG nSide, [in, defaultvalue(0)] LONGLONG nStyle, [out, retval, defaultvalue(NULL)] IUIX_CmdPane** ppCmdPane);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateCmdPane([in]                               IUIX_Obj*       pParent,
 +
                      [in]                               RECT*           pRect,
 +
                      [in]                               LONG           nSide,
 +
                      [in, defaultvalue(0)]             LONGLONG       nStyle,
 +
                      [out, retval, defaultvalue(NULL)] IUIX_CmdPane** pCmdPane);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''pParent''
+
;pParent
−
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in]  parent object of [[PXV:IUIX_Obj|IUIX_Obj]] interface.
−
;''pRect''
+
;pRect
−
:[in]  Pointer to RECT.
+
:[in]  dialog area where created object will be located.
−
;''nSide''
+
;nSide
−
:[in]  Value of LONG.
+
:[in]  specifies side in a dialog, where command pane will be located. Use values from [[PXV:UIX_CmdPaneSides|UIX_CmdPaneSides]] enumeration to set this parameter.
−
;''nStyle''
+
;nStyle
−
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  specifies command pane style with values from [[PXV:UIX_CmdPaneStyleFlags|UIX_CmdPaneStyleFlags]] enumeration.
−
;''ppCmdPane''
+
;pCmdPane
−
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_CmdPane|IUIX_CmdPane]].
+
:[out, retval, defaultvalue(NULL)]  return object of [[PXV:IUIX_CmdPane|IUIX_CmdPane]] interface.
  
 
== Return Value ==
 
== 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 ==
−
See also [[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 16:20, 15 June 2015

UI Layer > Interfaces > IUIX_Inst > IUIX_Inst::CreateCmdPane Method


Creates new object of IUIX_CmdPane interface.

Syntax

HRESULT CreateCmdPane([in]                               IUIX_Obj*       pParent,
                      [in]                               RECT*           pRect,
                      [in]                               LONG            nSide,
                      [in, defaultvalue(0)]              LONGLONG        nStyle,
                      [out, retval, defaultvalue(NULL)]  IUIX_CmdPane**  pCmdPane);

Parameters

pParent
[in] parent object of IUIX_Obj interface.
pRect
[in] dialog area where created object will be located.
nSide
[in] specifies side in a dialog, where command pane will be located. Use values from UIX_CmdPaneSides enumeration to set this parameter.
nStyle
[in, defaultvalue(0)] specifies command pane style with values from UIX_CmdPaneStyleFlags enumeration.
pCmdPane
[out, retval, defaultvalue(NULL)] return object of IUIX_CmdPane interface.

Return Value

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

See Also

IUIX_Inst

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IUIX_Inst_CreateCmdPane&oldid=47543"