IPXV_Inst::Init Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
Line 2: | Line 2: | ||
{{#customTitle:IPXV_Inst::Init Method}} | {{#customTitle:IPXV_Inst::Init Method}} | ||
− | + | This method initializes the main object instance and must be called first, '''before''' of calling any other method. | |
== Syntax == | == Syntax == | ||
Line 9: | Line 9: | ||
== Parameters == | == Parameters == | ||
;''pCtx'' | ;''pCtx'' | ||
− | :[in, optional] | + | :[in, optional] A pointer to '''IUnknown''' interface of context-object. This parameter is optional and can be NULL. |
;''pUserSettingsSrc'' | ;''pUserSettingsSrc'' | ||
− | :[in, optional] | + | :[in, optional] A pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]] object that specifies path to a source of all user's preferences. This parameter is optional and can be NULL. |
;''pRegistryPathToSettings'' | ;''pRegistryPathToSettings'' | ||
− | :[in, optional] | + | :[in, optional] Path to custom location in system's registry that contains all user's preferences. This parameter is optional and can be NULL. |
;''pHistoryFileName'' | ;''pHistoryFileName'' | ||
− | :[in, optional] Pointer to [[PXV:IAFS_Name|IAFS_Name]]. | + | :[in, optional] Pointer to [[PXV:IAFS_Name|IAFS_Name]] object that specifies the path to a source of documents opening history. This parameter is optional and can be NULL. |
;''pRegistryPathToHistory'' | ;''pRegistryPathToHistory'' | ||
− | :[in, optional] | + | :[in, optional] Path to a custom location in system's registry that contains documents opening history. This parameter is optional and can be NULL. |
;''pHistoryThumbsFileName'' | ;''pHistoryThumbsFileName'' | ||
− | :[in, optional] Pointer to [[PXV:IAFS_Name|IAFS_Name]]. | + | :[in, optional] Pointer to [[PXV:IAFS_Name|IAFS_Name]] object that specifies the path to a source of documents opening history thumbnails cache. This parameter is optional and can be NULL. |
;''nFlags'' | ;''nFlags'' | ||
− | :[in, optional] | + | :[in, optional] The advanced flags. This parameter is optional and can be 0. |
;''pReserved'' | ;''pReserved'' | ||
− | :[in, optional] | + | :[in, optional] The reserved parameter. Pass NULL there. |
== Return Value == | == Return Value == | ||
Line 29: | Line 29: | ||
== See Also == | == See Also == | ||
− | See also [[PXV:IPXV_Inst|IPXV_Inst]]. | + | See also [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IAFS_Name|IAFS_Name]], [[PXV:IAFS_File|IAFS_File]]. |
Revision as of 04:23, 21 March 2015
This method initializes the main object instance and must be called first, before of calling any other method.
Contents
Syntax
HRESULT Init([in, optional] IUnknown* pCtx, [in, optional] IUnknown* pUserSettingsSrc, [in, optional] BSTR pRegistryPathToSettings, [in, optional] IAFS_Name* pHistoryFileName, [in, optional] BSTR pRegistryPathToHistory, [in, optional] IAFS_Name* pHistoryThumbsFileName, [in, optional] LONG nFlags, [in, optional] IUnknown* pReserved);
Parameters
- pCtx
- [in, optional] A pointer to IUnknown interface of context-object. This parameter is optional and can be NULL.
- pUserSettingsSrc
- [in, optional] A pointer to IAFS_Name/IAFS_File object that specifies path to a source of all user's preferences. This parameter is optional and can be NULL.
- pRegistryPathToSettings
- [in, optional] Path to custom location in system's registry that contains all user's preferences. This parameter is optional and can be NULL.
- pHistoryFileName
- [in, optional] Pointer to IAFS_Name object that specifies the path to a source of documents opening history. This parameter is optional and can be NULL.
- pRegistryPathToHistory
- [in, optional] Path to a custom location in system's registry that contains documents opening history. This parameter is optional and can be NULL.
- pHistoryThumbsFileName
- [in, optional] Pointer to IAFS_Name object that specifies the path to a source of documents opening history thumbnails cache. This parameter is optional and can be NULL.
- nFlags
- [in, optional] The advanced flags. This parameter is optional and can be 0.
- pReserved
- [in, optional] The reserved parameter. Pass NULL there.
Return Value
Returns S_OK if operation was successful or error code in other cases.