Метод IPart::GetGlobalId (devicetopology.h)
Метод GetGlobalId получает глобальный идентификатор этой части.
Синтаксис
HRESULT GetGlobalId(
[out] LPWSTR *ppwstrGlobalId
);
Параметры
[out] ppwstrGlobalId
Указатель на переменную указателя, в которую метод записывает адрес строки с расширенными символами, заканчивающейся null, которая содержит глобальный идентификатор. Метод выделяет хранилище для строки. Вызывающий объект отвечает за освобождение хранилища, когда оно больше не требуется, путем вызова функции CoTaskMemFree . Если вызов GetGlobalId завершается сбоем, *ppwstrGlobalId имеет значение NULL. Сведения о CoTaskMemFree см. в документации по Windows SDK.
Возвращаемое значение
Если метод завершается успешно, возвращает значение S_OK. В случае сбоя возможные коды возврата включают, но не ограничиваются ими, значения, показанные в следующей таблице.
Код возврата | Описание |
---|---|
|
Указатель ppwstrGlobalId имеет значение NULL. |
|
Недостаточно памяти. |
Комментарии
Глобальный идентификатор — это строка, которая однозначно идентифицирует часть среди всех частей во всех топологиях устройств в системе. Клиенты должны рассматривать эту строку как непрозрачную. Это значит, что клиенты не должны пытаться проанализировать содержимое строки, чтобы получить сведения о части. Причина заключается в том, что формат строки не определен и может измениться с одной реализации API DeviceTopology на другую.
Требования
Требование | Значение |
---|---|
Минимальная версия клиента | Windows Vista [только классические приложения] |
Минимальная версия сервера | Windows Server 2008 [только классические приложения] |
Целевая платформа | Windows |
Header | devicetopology.h |