IPXV_Inst::SaveHistory Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::SaveHistory Method}}
 
{{#customTitle:IPXV_Inst::SaveHistory Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|SaveHistory|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Stores the documents opening history to specified storage.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT SaveHistory([in] IAFS_Name* pHistoryFileName, [in, optional] BSTR pRegistryPathToHistory, [in, optional] LONG nFlags);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT SaveHistory([in]                   IUnknown* pHistoryDest,
 +
                    [in]                   IUnknown*  pHistoryThumbsDest,
 +
                    [in, defaultvalue(0)] LONG       nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pHistoryFileName''
+
;pHistoryDest
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
+
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/IStream object. 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:
;''pRegistryPathToHistory''
+
:<tt>HKEY_CURRENT_USER\Software\MyApp\PDFEditorRecents</tt>
:[in, optionalValue of BSTR.
+
:<tt>HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditoRecents</tt>
;''nFlags''
+
The list of supported registry-root names: <tt>HKEY_CLASSES_ROOT, HKCR, HKEY_CURRENT_USER, HKCU, HKEY_LOCAL_MACHINE, HKLM</tt>.
:[in, optionalValue of LONG.
+
;pHistoryThumbsDest
 +
:[in]  :[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/IStream.  Also via [[PXV:IString|IString]] you may specify path to local file.
 +
;nFlags
 +
:[in, defaultvalue(0)The reserved parameter. Pass 0 there.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 27:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_Init|IPXV_Inst::Init]], [[PXV:IPXV_Inst_SaveUserSettings|IPXV_Inst::SaveUserSettings]]

Latest revision as of 03:57, 15 June 2015


Stores the documents opening history to specified storage.

Syntax

HRESULT SaveHistory([in]                   IUnknown*  pHistoryDest,
                    [in]                   IUnknown*  pHistoryThumbsDest,
                    [in, defaultvalue(0)]  LONG       nFlags);

Parameters

pHistoryDest
[in] Pointer to IAFS_Name/IAFS_File/IStream object. 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\PDFEditorRecents
HKEY_LOCAL_MACHINE\Software\MyApp\PDFEditoRecents

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

pHistoryThumbsDest
[in]  :[in] Pointer to IAFS_Name/IAFS_File/IStream. Also via IString you may specify path to local file.
nFlags
[in, defaultvalue(0)] The reserved parameter. Pass 0 there.

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::Init, IPXV_Inst::SaveUserSettings