IPXV_Inst::SaveUserSettings Method

Revision as of 14:57, 26 May 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 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.

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::SaveHistory