IPXV_Inst::SaveUserSettings Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::SaveUserSettings Method}} | {{#customTitle:IPXV_Inst::SaveUserSettings Method}} | ||
| + | {{#parentPage:PXV:IPXV_Inst#Methods|SaveUserSettings|method}} | ||
| + | {{ToReview}} | ||
Save all user's preferences to specified storage. | Save all user's preferences to specified storage. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT SaveUserSettings([in] IUnknown* pUserSettingsDest, [in, defaultvalue(0)] LONG nFlags);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT SaveUserSettings([in] IUnknown* pUserSettingsDest, |
| + | [in, defaultvalue(0)] LONG nFlags);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pUserSettingsDest |
| − | :[in] A pointer to | + | :[in] A pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/IStream object that specifies the destination of all user's preferences. This parameter is optional and can be NULL. Also via [[PXV:IString|IString]] (see [[PXV:IPXV_Inst_CreateString|IPXV_Inst::CreateString]]) 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\PDFEditorSettings</tt> |
| − | :[in, defaultvalue(0)] | + | :<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>. | ||
| + | ;nFlags | ||
| + | :[in, defaultvalue(0)] The reserved parameter. Pass 0 there. | ||
== Return Value == | == Return Value == | ||
| Line 17: | Line 24: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_Init|IPXV_Inst::Init]], [[PXV:IPXV_Inst_SaveHistory|IPXV_Inst::SaveHistory]] | |
Latest revision as of 12:52, 31 July 2015
Save all user's preferences to specified storage.
Syntax
HRESULT SaveUserSettings([in] IUnknown* pUserSettingsDest,
[in, defaultvalue(0)] LONG nFlags);
Parameters
- pUserSettingsDest
- [in] A pointer to IAFS_Name/IAFS_File/IStream object that specifies the destination of all user's preferences. This parameter is optional and can be NULL. Also via IString (see IPXV_Inst::CreateString) 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.
- 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.
