Web API Reference | MapGuide Open Source

- Overview
- Modules
- Classes

# MgUserInformation Class Reference
[MgUserInformation]

This class manages user information. More...

Inherits MgSerializable.

List of all members.

## Public Member Functions
STRING | GetLocale ()
| Retrieves the locale for the user.
MgByteReader * | GetReader ()
| Returns an encrypted MgByteReader for the given credentials. This byte reader can then be used to populate credentials into any resource which requires default credentials. Some feature sources (Oracle Databases) and some drawing sources (password protected DWFs) may require default credentials to access them. See MgResourceService::SetResourceData for more information.
| MgUserInformation (CREFSTRING userName, CREFSTRING password)
| Constructs information object with a MapGuide user name and password.
| MgUserInformation (CREFSTRING sessionId)
| Constructs an information object from a session identifier.
| MgUserInformation ()
| Constructs an unintialized information object.
void | SetLocale (CREFSTRING locale)
| Sets the desired locale for the user.
void | SetMgSessionId (CREFSTRING sessionId)
| Initializes user information with a MapGuide session identifier. A session identifier can be created for the current user via MgSite::CreateSession. In order to obtain a session identifier, MgSiteConnection must be opened with valid credentials. Once opened, GetSite can be called to obtain MgSite which can then be used to create a session identifier for the currently logged in user.
void | SetMgUsernamePassword (CREFSTRING userName, CREFSTRING password)
| Initializes credentials with a MapGuide user name and password.

## Detailed Description

This class manages user information.

Remarks:
  Information includes the user's locale, session information, and credentials. Credentials are based on MapGuide authentication only.

Comments or suggestions? Send us feedback.