IProfAdmin::SetDefaultProfile
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
Sets or clears a client's default profile.
HRESULT SetDefaultProfile(
LPTSTR lpszProfileName,
ULONG ulFlags
);
Parameters
lpszProfileName
[in] A pointer to the name of the profile that will become the default, or NULL. Setting lpszProfileName to NULL indicates that SetDefaultProfile should remove the existing default profile, leaving the client without a default.ulFlags
[in] A bitmask of flags that controls the type of the string pointed to by lpszProfileName. The following flag can be set:- MAPI_UNICODE
The profile name is in Unicode format. If the MAPI_UNICODE flag is not set, the profile name is in ANSI format.
- MAPI_UNICODE
Return Value
S_OK
A default profile was successfully established or removed.MAPI_E_NOT_FOUND
The specified profile does not exist.
Remarks
The IProfAdmin::SetDefaultProfile method either establishes a particular profile as the client's default profile or clears the current default profile. The default profile is the profile that is automatically used whenever the client begins a MAPI session. SetDefaultProfile also sets the new default profile's PR_DEFAULT_PROFILE (PidTagDefaultProfile) property to TRUE.
Notes to Callers
To start a session with the default profile, pass the MAPI_USE_DEFAULT flag to the MAPILogonEx function.