IProfAdmin::SetDefaultProfile

Last modified: July 23, 2011

Applies to: Outlook

Sets or clears a client's default profile.

HRESULT SetDefaultProfile(
  LPSTR lpszProfileName,
  ULONG ulFlags
);

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.

S_OK

A default profile was successfully established or removed.

MAPI_E_NOT_FOUND

The specified profile does not exist.

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.

To start a session with the default profile, pass the MAPI_USE_DEFAULT flag to the MAPILogonEx function.

Show: