IProfAdmin::RenameProfile
Applies to: Outlook 2013 | Outlook 2016
Assigns a new name to a profile.
HRESULT RenameProfile(
LPSTR lpszOldProfileName,
LPSTR lpszOldPassword,
LPSTR lpszNewProfileName,
ULONG_PTR ulUIParam,
ULONG ulFlags
);
Parameters
lpszOldProfileName
[in] A pointer to the current name of the profile to rename.
lpszOldPassword
[in] Always NULL.
lpszNewProfileName
[in] A pointer to the new name of the profile to rename.
ulUIParam
[in] A handle to the parent window of any dialog boxes or windows that this method displays.
ulFlags
[in] Always NULL.
Return value
S_OK
The profile was successfully renamed.
MAPI_E_LOGON_FAILED
The profile password is incorrect.
MAPI_E_USER_CANCEL
The user canceled the operation, typically by clicking the Cancel button in a dialog box.
Remarks
The IProfAdmin::RenameProfile method assigns a new name to a profile, if it has one. If the profile to rename is in use by a client when RenameProfile is called, RenameProfile marks the profile and returns S_OK instead of attempting the rename operation while the profile is in use. When the profile is no longer being used, RenameProfile assigns it the new name.
The old and new names of the profile can be up to 64 characters in length and can include the following characters:
All alphanumeric characters, including accent characters and the underscore character.
Embedded spaces, but not leading or trailing spaces.
The lpszPassword should always be NULL or a pointer to a zero-length string.