IProfAdmin::GetProfileTable
The IProfAdmin::GetProfileTable
method provides access to the profile table, a table with information about all
of the available profiles.
Quick Info
See IProfAdmin
: IUnknown
HRESULT GetProfileTable(
ULONG ulFlags,
|
|
LPMAPITABLE FAR * lppTable |
|
) |
|
Parameters
ulFlags
[in] Bitmask
of flags that controls the type of the strings returned in the table s columns.
The following flag can be set:
MAPI_UNICODE
The string
columns are in Unicode format. If the MAPI_UNICODE flag is not set, the columns
are in ANSI format.
lppTable
[out] Pointer
to the pointer to the profile table.
Return Values
S_OK
The profile
table was successfully retrieved.
Remarks
The IProfAdmin::GetProfileTable
method provides access to the profile table, a table with one row for every
available profile. There are only two columns in each row: the profile s
display name and a flag that indicates whether or not the profile is the
default.
Profiles that
have been deleted, or that are in use but have been marked for deletion, are
not included in the profile table. The profile table is static; subsequent
additions and deletions of profiles are not reflected in the table.
If no
profiles exist, GetProfileTable returns a table with zero rows.
Setting the
MAPI_UNICODE flag in the ulFlags parameter affects the format of the
columns returned from the following IMAPITable methods:
IMAPITable::QueryColumns
IMAPITable::QueryRows
This flag
also controls the property types in the sort order returned by the IMAPITable::QuerySortOrder
For more
information about the profile table, see Profile Table
See Also