Share via

Метод IMMDevice::GetId (mmdeviceapi.h)

  • Статья

Метод GetId извлекает строку идентификатора конечной точки , которая идентифицирует устройство конечной точки звука.

Синтаксис

HRESULT GetId(
  [out] LPWSTR *ppstrId
);

Параметры

[out] ppstrId

Указатель на переменную указателя, в которую метод записывает адрес завершаемой null строкой с расширенными символами, содержащей идентификатор устройства конечной точки. Метод выделяет хранилище для строки. Вызывающий объект отвечает за освобождение хранилища, когда оно больше не требуется, путем вызова функции CoTaskMemFree . Если вызов GetId завершается ошибкой, *ppstrId имеет значение NULL. Сведения о CoTaskMemFree см. в документации по Windows SDK.

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

Если метод завершается успешно, возвращает значение S_OK. В случае сбоя возможные коды возврата включают, но не ограничиваются ими, значения, показанные в следующей таблице.

Код возврата Описание
E_OUTOFMEMORY
 Недостаточно памяти.
E_POINTER
 Параметр pwstrId имеет значение NULL.

Комментарии

Строка идентификатора конечной точки, полученная из этого метода, идентифицирует устройство конечной точки звука, представленное экземпляром интерфейса IMMDevice . Клиент может использовать строку идентификатора конечной точки для создания экземпляра звукового конечного устройства позже или в другом процессе путем вызова метода IMMDeviceEnumerator::GetDevice . Клиенты должны рассматривать содержимое строки идентификатора конечной точки как непрозрачные. Это значит, что клиенты не должны пытаться проанализировать содержимое строки для получения сведений об устройстве. Причина заключается в том, что формат строки не определен и может измениться от одной реализации системного модуля API MMDevice к следующей.

Примеры кода, вызывающие метод GetId , см. в следующих разделах:

Требования

   
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2008 [только классические приложения]
Целевая платформа Windows
Header mmdeviceapi.h

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

Интерфейс IMMDevice

IMMDeviceEnumerator::GetDevice