IUIX_Inst::CreateInfoBtn Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateInfoBtn Method}}
 
{{#customTitle:IUIX_Inst::CreateInfoBtn Method}}
{{#parentPage:PXV:IUIX_Inst|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|CreateInfoBtn|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new object of [[PXV:IUIX_InfoBtn|IUIX_InfoBtn]] interface.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateInfoBtn([in] IUIX_Obj* pParent, [in] RECT* pRect, [in] BSTR pID, [in, defaultvalue(0)] LONGLONG nStyle, [in, optional] IUnknown* pCustomImpl, [out, retval, defaultvalue(NULL)] IUIX_InfoBtn** ppInfoBtn);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateInfoBtn([in]                               IUIX_Obj*       pParent,
 +
                      [in]                               RECT*           pRect,
 +
                      [in]                               BSTR           pID,
 +
                      [in, defaultvalue(0)]             LONGLONG       nStyle,
 +
                      [in, defaultvalue(NULL)]           IUnknown*       pCustomImpl,
 +
                      [out, retval, defaultvalue(NULL)] IUIX_InfoBtn** pInfoBtn);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pParent''
+
;pParent
:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+
:[in]  parent object.
;''pRect''
+
;pRect
:[in]  Pointer to RECT.
+
:[in]  dialog area where created object will be located.
;''pID''
+
;pID
:[in]  Value of BSTR.
+
:[in]  string ID of created object.
;''nStyle''
+
;nStyle
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  info button style flags from [[PXV:UIX_InfoBtnStyleFlags|UIX_InfoBtnStyleFlags]] enumeration.
;''pCustomImpl''
+
;pCustomImpl
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  custom implementation of [[PXV:IUIX_Button|IUIX_Button]] interface. Set this parameter if you need to use your own interface implementation instead of default one.
;''ppInfoBtn''
+
;pInfoBtn
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_InfoBtn|IUIX_InfoBtn]].
+
:[out, retval, defaultvalue(NULL)]  return object of [[PXV:IUIX_InfoBtn|IUIX_InfoBtn]] 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 09:58, 16 June 2015


Creates new object of IUIX_InfoBtn interface.

Syntax

HRESULT CreateInfoBtn([in]                               IUIX_Obj*       pParent,
                      [in]                               RECT*           pRect,
                      [in]                               BSTR            pID,
                      [in, defaultvalue(0)]              LONGLONG        nStyle,
                      [in, defaultvalue(NULL)]           IUnknown*       pCustomImpl,
                      [out, retval, defaultvalue(NULL)]  IUIX_InfoBtn**  pInfoBtn);

Parameters

pParent
[in] parent object.
pRect
[in] dialog area where created object will be located.
pID
[in] string ID of created object.
nStyle
[in, defaultvalue(0)] info button style flags from UIX_InfoBtnStyleFlags enumeration.
pCustomImpl
[in, optional] custom implementation of IUIX_Button interface. Set this parameter if you need to use your own interface implementation instead of default one.
pInfoBtn
[out, retval, defaultvalue(NULL)] return object of IUIX_InfoBtn interface.

Return Value

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

See Also

IUIX_Inst