IPXV_Inst::Init Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 19: Line 19:
 
== Parameters ==
 
== Parameters ==
 
;pCtx
 
;pCtx
:[in, optional]  A pointer to '''IUnknown''' interface of context-object. This parameter is optional and can be NULL.
+
:[in, optional]  A pointer to '''IUnknown''' interface of context-object. This parameter is optional and can be NULL. Reserved for the future.
 
;pLicKey
 
;pLicKey
 
:[in, optional]  A pointer to unicode string that contains developer's license key. This parameter is optional and can be empty - in this case the SDK will work in DEMO mode.  
 
:[in, optional]  A pointer to unicode string that contains developer's license key. This parameter is optional and can be empty - in this case the SDK will work in DEMO mode.  
 
;pUserSettingsSrc
 
;pUserSettingsSrc
:[in, optional]  A pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]] object that specifies the source of all user's preferences. This parameter is optional and can be NULL. Also via [[PXV:IString|IString]] you may specify path to local file or path to custom location in system's registry in format for example:
+
:[in, optional]  A pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/IStream object that specifies the source of all user's preferences. This parameter is optional and can be NULL. Also via [[PXV:IString|IString]] you may specify path to local file or path to custom location in system's registry in format for example:
  
:<tt>HKEY_CURRENT_USER\Software\MyApp\PDFEditorSetting</tt>
+
:<tt>HKEY_CURRENT_USER\Software\MyApp\PDFEditorSettings</tt>
:<tt>HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSetting</tt>
+
:<tt>HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSettings</tt>
  
 
The list of supported registry-root names: <tt>HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM</tt>.
 
The list of supported registry-root names: <tt>HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM</tt>.
  
;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.
 
 
;pHistorySrc
 
;pHistorySrc
:[in, optional]  Pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]] object that specifies the source of documents opening history. This parameter is optional and can be NULL.
+
:[in, optional]  Pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/IStream object that specifies the source of documents opening history. This parameter is optional and can be NULL. Also via [[PXV:IString|IString]] you may specify path to local file or path to custom location in system's registry (see description for <tt>pUserSettingsSrc</tt>).
 +
 
 +
;pHistoryThumbsSrc
 +
:[in, optional]  Pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/[[PXV:IString|IString]]/IStream object that specifies the source of thumbnails-cache for documents opening history. This parameter is optional and can be NULL.
 +
 
 
;pRegistryPathToHistory
 
;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.
 
:[in, optional]  Path to a custom location in system's registry that contains documents opening history. This parameter is optional and can be NULL.
Line 39: Line 41:
 
:[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.
 
:[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]  The advanced flags. This parameter is optional and can be 0.
+
:[in, optional]  The reserved parameter. Pass 0 there.
 +
 
 
;pReserved
 
;pReserved
 
:[in, optional]  The reserved parameter. Pass NULL there.
 
:[in, optional]  The reserved parameter. Pass NULL there.

Revision as of 12:17, 24 May 2015


This method initializes the main object instance and must be called first, before of calling any other method.

Syntax

HRESULT Init([in, defaultvalue(NULL)]  IUnknown*  pCtx,
             [in, defaultvalue("")]    BSTR       pLicKey,
             [in, defaultvalue(NULL)]  IUnknown*  pUserSettingsSrc,
             [in, defaultvalue(NULL)]  IUnknown*  pHistorySrc,
             [in, defaultvalue(NULL)]  IUnknown*  pHistoryThumbsSrc,
             [in, defaultvalue(0)]     LONG       nFlags,
             [in, defaultvalue(NULL)]  IUnknown*  pReserved);

Parameters

pCtx
[in, optional] A pointer to IUnknown interface of context-object. This parameter is optional and can be NULL. Reserved for the future.
pLicKey
[in, optional] A pointer to unicode string that contains developer's license key. This parameter is optional and can be empty - in this case the SDK will work in DEMO mode.
pUserSettingsSrc
[in, optional] A pointer to IAFS_Name/IAFS_File/IStream object that specifies the source of all user's preferences. This parameter is optional and can be NULL. Also via IString you may specify path to local file or path to custom location in system's registry in format for example:
HKEY_CURRENT_USER\Software\MyApp\PDFEditorSettings
HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditorSettings

The list of supported registry-root names: HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM.

pHistorySrc
[in, optional] Pointer to IAFS_Name/IAFS_File/IStream object that specifies the source of documents opening history. This parameter is optional and can be NULL. Also via IString you may specify path to local file or path to custom location in system's registry (see description for pUserSettingsSrc).
pHistoryThumbsSrc
[in, optional] Pointer to IAFS_Name/IAFS_File/IString/IStream object that specifies the source of thumbnails-cache for 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 reserved parameter. Pass 0 there.
pReserved
[in, optional] The reserved parameter. Pass NULL there.

Return Value

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

See Also

IPXV_Inst