Функция MgmGroupEnumerationStart (mgm.h)

Статья
08/24/2023

Функция MgmGroupEnumerationStart получает дескриптор перечисления, который позже используется для получения списка групп, которые были присоединены. После получения дескриптора клиент должен использовать функцию MgmGroupEnumerationGetNext для перечисления групп.

Синтаксис

DWORD MgmGroupEnumerationStart(
  [in]  HANDLE         hProtocol,
  [in]  MGM_ENUM_TYPES metEnumType,
  [out] HANDLE         *phEnumHandle
);

Параметры

[in] hProtocol

Дескриптор протокола, полученного при предыдущем вызове MgmRegisterMProtocol.

[in] metEnumType

Указывает тип перечисления. Доступны следующие перечисления.

Перечисление	Значение
ALL_SOURCES	Извлекает соединения с подстановочными знаками (*, g) и соединения для конкретного источника (s, g).
ANY_SOURCE	Извлекает записи групп, в которых указан хотя бы один источник.

[out] phEnumHandle

Получает дескриптор перечисления . Используйте этот дескриптор в вызовах MgmGroupEnumerationGetNext и MgmGroupEnumerationEnd.

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение будет NO_ERROR.

Если функция завершается сбоем, возвращаемое значение представляет собой один из следующих кодов ошибок.

Значение	Значение
ERROR_CAN_NOT_COMPLETE	Не удалось завершить вызов этой функции.
ERROR_INVALID_PARAMETER	Недопустимый дескриптор протокола.
ERROR_NOT_ENOUGH_MEMORY	Недостаточно памяти для выполнения этой операции.

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	mgm.h
Библиотека	Rtm.lib
DLL	Rtm.dll

См. также раздел

MGM_ENUM_TYPES

MgmGroupEnumerationEnd

MgmGroupEnumerationGetNext

Поделиться через