IUIX_Inst::CreateList Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IUIX_Inst::CreateList Method}}
 
{{#customTitle:IUIX_Inst::CreateList Method}}
 
{{#parentPage:PXV:IUIX_Inst|CreateList Method|method}}
 
{{#parentPage:PXV:IUIX_Inst|CreateList Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Creates new ''list'' object of [[PXV:IUIX_List|IUIX_List]] interface.
  
 
== Syntax ==
 
== Syntax ==
Line 19: Line 18:
 
== 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.
 
;pID
 
;pID
:[in]  Value of BSTR.
+
:[in]  string ID of created object.
 
;nStyle
 
;nStyle
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  specifies list style with flags from [[PXV:UIX_ListStyleFlags|UIX_ListStyleFlags]] enumeration.
 
;nScrollStyle
 
;nScrollStyle
:[in, defaultvalue(0)]  Value of LONGLONG.
+
:[in, defaultvalue(0)]  specifies scroll type with flags from [[PXV:UIX_ScrollStyleFlags|UIX_ScrollStyleFlags]] enumeration.
 
;pCustomImpl
 
;pCustomImpl
:[in, optional]  Pointer to IUnknown*.
+
:[in, optional]  custom implementation of [[PXV:IUIX_List|IUIX_List]] interface. Set this parameter if you need to use your own interface implementation instead of default one.
 
;ppList
 
;ppList
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_List|IUIX_List]].
+
:[out, retval, defaultvalue(NULL)]  return object of [[PXV:IUIX_List|IUIX_List]] interface.
  
 
== Return Value ==
 
== Return Value ==
Line 37: Line 36:
  
 
== See Also ==
 
== See Also ==
[[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]], [[PXV:IUIX_List|IUIX_List]].

Revision as of 08:33, 20 May 2015


Creates new list object of IUIX_List interface.

Syntax

HRESULT CreateList([in]                               IUIX_Obj*    pParent,
                   [in]                               RECT*        pRect,
                   [in]                               BSTR         pID,
                   [in, defaultvalue(0)]              LONGLONG     nStyle,
                   [in, defaultvalue(0)]              LONGLONG     nScrollStyle,
                   [in, defaultvalue(NULL)]           IUnknown*    pCustomImpl,
                   [out, retval, defaultvalue(NULL)]  IUIX_List**  ppList);

Parameters

pParent
[in] parent object of IUIX_Obj interface.
pRect
[in] dialog area where created object will be located.
pID
[in] string ID of created object.
nStyle
[in, defaultvalue(0)] specifies list style with flags from UIX_ListStyleFlags enumeration.
nScrollStyle
[in, defaultvalue(0)] specifies scroll type with flags from UIX_ScrollStyleFlags enumeration.
pCustomImpl
[in, optional] custom implementation of IUIX_List interface. Set this parameter if you need to use your own interface implementation instead of default one.
ppList
[out, retval, defaultvalue(NULL)] return object of IUIX_List interface.

Return Value

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

See Also

IUIX_Inst, IUIX_List.