IPXV_Inst::CreateStdPresetsCallbacks Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_Inst::CreateStdPresetsCallbacks Method}}
 
{{#customTitle:IPXV_Inst::CreateStdPresetsCallbacks Method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|CreateStdPresetsCallbacks|method}}
 
{{#parentPage:PXV:IPXV_Inst#Methods|CreateStdPresetsCallbacks|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Creates new object that implements [[PXV:IPXV_PresetsListCallbacks|IPXV_PresetsListCallbacks]] interface in standard way and provides access to settings presets database.
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 16:
 
== Parameters ==
 
== Parameters ==
 
;pPathToPresetsArr
 
;pPathToPresetsArr
:[in]  Value of BSTR.
+
:[in]  Specifies path to presets node in global or custom storage of parameters.
 
;pCustomIoCallbacks
 
;pCustomIoCallbacks
:[in]  Pointer to [[PXV:IPXV_PresetsIoCallbacks|IPXV_PresetsIoCallbacks]].
+
:[in]  The optional pointer to [[PXV:IPXV_PresetsIoCallbacks|IPXV_PresetsIoCallbacks]]. You may implement this callback and pass here to have a possibility to intercept some notifications about changing of presets database.
 
;pCustomStorage
 
;pCustomStorage
:[in, defaultvalue(NULL)]  Pointer to [[PXV:ICab|ICab]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:ICab|ICab]] object that must be a database of settings presets with special predefined structure.
 
;nListStyle
 
;nListStyle
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  The set of [[PXV:PXV_PresetsListStyleFlags|PXV_PresetsListStyleFlags]] to customize displaying in UI the preset-items and to setup special edit-restrictions for end-user.
 
;ppRes
 
;ppRes
:[out, retval]  Pointer to [[PXV:IPXV_PresetsListCallbacks|IPXV_PresetsListCallbacks]].
+
:[out, retval]  Returns pointer to a new [[PXV:IPXV_PresetsListCallbacks|IPXV_PresetsListCallbacks]] object.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 16:07, 24 May 2015


Creates new object that implements IPXV_PresetsListCallbacks interface in standard way and provides access to settings presets database.

Syntax

HRESULT CreateStdPresetsCallbacks([in]                      BSTR                         pPathToPresetsArr,
                                  [in]                      IPXV_PresetsIoCallbacks*     pCustomIoCallbacks,
                                  [in, defaultvalue(NULL)]  ICab*                        pCustomStorage,
                                  [in, defaultvalue(0)]     LONG                         nListStyle,
                                  [out, retval]             IPXV_PresetsListCallbacks**  ppRes);

Parameters

pPathToPresetsArr
[in] Specifies path to presets node in global or custom storage of parameters.
pCustomIoCallbacks
[in] The optional pointer to IPXV_PresetsIoCallbacks. You may implement this callback and pass here to have a possibility to intercept some notifications about changing of presets database.
pCustomStorage
[in, defaultvalue(NULL)] Pointer to ICab object that must be a database of settings presets with special predefined structure.
nListStyle
[in, defaultvalue(0)] The set of PXV_PresetsListStyleFlags to customize displaying in UI the preset-items and to setup special edit-restrictions for end-user.
ppRes
[out, retval] Returns pointer to a new IPXV_PresetsListCallbacks object.

Return Value

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

See Also

IPXV_Inst