#include <FxProfile.h>
Description: Represents the profile manager. Library: DDKERNEL
Definition at line 206 of file FxProfile.h.
◆ addReactor()
Description: This function adds a reactor to receive profile change event notifications.
◆ ProfileCopy()
| virtual int CFxProfileManager::ProfileCopy |
( |
const CFxString & | newProfileName, |
|
|
const CFxString & | oldProfileName, |
|
|
const CFxString & | newProfileDesc ) |
|
pure virtual |
Description: A new profile is created with the new name and description. If the profile name already exists, it will be overwritten (if it's not the current profile). The ARGON settings from the old profile are copied into the new profile.
The function could return with the following return codes: eProfileDoesNotExist The old profile name is not found in the registry. eInvalidProfileName Invalid characters in the new profile name. eProfileIsInUse Cannot copy into current profile. eRegistryAccessError Could not access registry. eOk Operation completed successfully. Arguments:
- Parameters
-
| newProfileName | Input new profile name |
| oldProfileName | Input profile name to be copied |
| newProfileDesc | Input new profile description |
◆ ProfileDelete()
| virtual int CFxProfileManager::ProfileDelete |
( |
const CFxString & | strProfileName | ) |
|
|
pure virtual |
Description: Deletes the profile specified in strProfileName from the registry.
The function could return with the following return codes: eProfileDoesNotExist The specified profile name is not found in the registry. eProfileIsInUse Cannot delete the current profile. eRegistryAccessError Could not access/update registry. eOk Operation completed successfully. Arguments:
- Parameters
-
| strProfileName | Input profile name |
◆ ProfileExport()
| virtual int CFxProfileManager::ProfileExport |
( |
const CFxString & | strProfileName, |
|
|
const CFxString & | exportFileName ) |
|
pure virtual |
Description: The ARGON settings in the registry for the specified profile, strProfileName, are written out to the .arg file, exportFileName, in REGEDIT4 format.
The function could return with the following return codes: eProfileDoesNotExist The specified profile name is not found in the registry. eNoFileName No file name specified. eInvalidFileExtension The file should have an .arg extension. eCantOpenFile File permission error. eRegistryAccessError Could not access/update registry. eOk Operation completed successfully. Arguments:
- Parameters
-
| strProfileName | Input profile name |
| exportFileName | Output .arg file name |
◆ ProfileGet()
◆ ProfileGetCurrent()
| virtual CFxProfile * CFxProfileManager::ProfileGetCurrent |
( |
| ) |
|
|
pure virtual |
◆ ProfileGetFixed()
| virtual CFxProfile * CFxProfileManager::ProfileGetFixed |
( |
| ) |
|
|
pure virtual |
◆ ProfileImport()
| virtual int CFxProfileManager::ProfileImport |
( |
const CFxString & | strProfileName, |
|
|
const CFxString & | importFileName, |
|
|
const CFxString & | profileDescription, |
|
|
bool | bImportPathInfo ) |
|
pure virtual |
Description: A new profile is created with the specified name, strProfileName, and description, profileDescription. If the profile already exists, it will be overwritten (if it is not the current profile). The ARGON settings from the specified .arg file, importFileName, are read into the registry for the new profile. bImportPathInfo determines whether the path information in the file should be read in or ignored.
The function could return with the following return codes: eInvalidProfileName Invalid characters in the Profile name. eNoFileName No file name specified. eInvalidFileExtension The file should have an .arg extension. eProfileIsInUse Cannot import into the current profile. eCantOpenFile File permission error. eRegistryCreateError Could not update registry. eRegistryAccessError Could not access registry. eOk Operation completed successfully. Arguments:
- Parameters
-
| strProfileName | Input profile name |
| importFileName | Input .arg file name |
| profileDescription | Input profile description |
| bImportPathInfo | Input Boolean indicating whether path information should be read in or ignored |
◆ ProfileListNames()
Description: This function returns the profile names list via the AcApProfileNameArray argument, nameList. When passed in, this array should be empty. It is the caller’s responsibility to delete the entries of the array. Arguments:
- Parameters
-
| nameList | Passed in AcApProfileNameArray Return Value: Returns the number of profiles in the registry. |
◆ ProfileRegistryKey()
| virtual void CFxProfileManager::ProfileRegistryKey |
( |
CFxString & | strRegProfileKey, |
|
|
const CFxString & | strProfileName ) |
|
pure virtual |
Description: The registry path for the specified profile, strProfileName, is returned via strRegProfileKey if the profile is found in the registry. Arguments:
- Parameters
-
| strRegProfileKey | Output registry path |
| strProfileName | Input profile name |
◆ ProfileRename()
| virtual int CFxProfileManager::ProfileRename |
( |
const CFxString & | newProfileName, |
|
|
const CFxString & | oldProfileName, |
|
|
const CFxString & | newProfileDesc ) |
|
pure virtual |
Description: Renames an existing profile, oldProfileName, to a new name, newProfileName, with a new description, newProfileDesc.
The function could return with the following return codes: eProfileDoesNotExist The specified profile name is not found in the registry. eInvalidProfileName Invalid characters in the new profile name. eProfileIsInUse Cannot rename a profile to the name of the current profile. eRegistryAccessError Could not access/update registry. eOk Operation completed successfully. Arguments:
- Parameters
-
| newProfileName | Input new profile name |
| oldProfileName | Input old profile name |
| newProfileDesc | Input new profile description |
◆ ProfileReset()
| virtual int CFxProfileManager::ProfileReset |
( |
const CFxString & | strProfileName | ) |
|
|
pure virtual |
Description: The settings under the profile strProfileName are deleted and the profile reverts to default settings.
The function could return with the following return codes: eProfileDoesNotExist The specified profile name is not found in the registry. eRegistryAccessError Could not access/update registry. eOk Operation completed successfully. Arguments:
- Parameters
-
| strProfileName | Input profile name |
◆ ProfileSave()
| virtual int CFxProfileManager::ProfileSave |
( |
const CFxString & | profileName | ) |
|
|
pure virtual |
Description: This function force profile saving.
The function could return with the following return codes: eProfileDoesNotExist The specified profile name is not found in the registry. eOk Operation completed successfully.
◆ ProfileSetCurrent()
| virtual int CFxProfileManager::ProfileSetCurrent |
( |
const CFxString & | strProfileName | ) |
|
|
pure virtual |
Description: The profile specified, strprofileName, is made the current profile for the ARGON session.
The function could return with the following return codes: eProfileDoesNotExist The specified profile name is not found in the registry. eRegistryAccessError Could not access/update registry. eOk Operation completed successfully. Arguments:
- Parameters
-
| strProfileName | Input profile name |
◆ removeReactor()
Description: This function removes a reactor.
The documentation for this class was generated from the following file: