Метод IDebugFAEntryTags::GetProperties (extsfns.h)

Статья
02/26/2024

Метод GetProperties получает имя или описание (или оба) тега в объекте DebugFailureAnalysisTags .

Синтаксис

HRESULT GetProperties(
            FA_TAG Tag,
  [out]     PSTR   Name,
  [in, out] PULONG NameSize,
  [out]     PSTR   Description,
  [in, out] PULONG DescSize,
  [out]     PULONG Flags
);

Параметры

Tag

Значение в перечислении FA_TAG . Этот метод получает имя или описание (или оба) этого тега.

[out] Name

Указатель на буфер, получающий строку, завершающуюся null, которая является именем тега. Если NameSize меньше длины имени тега, этот метод копирует в этот буфер только байты NameSize , включая признак конца NULL .

[in, out] NameSize

На входных данных этот параметр задает размер буфера, на который указывает имя , в байтах. В выходных данных этот параметр получает размер (в байтах) имени тега. Если тег не имеет имени, этот параметр получает значение 0.

Примечание Если name имеет значение NULL, этот параметр не получает никаких сведений. Следует задать значения Name и NameSize для значений, отличных от NULL, или задать для них значение NULL.

[out] Description

Указатель на буфер, получающий строку с пустым завершением, которая является описанием тега. Если DescSize меньше длины описания тега, этот метод копирует в этот буфер только байты DescSize , включая признак конца NULL .

[in, out] DescSize

Во входных данных этот параметр указывает размер (в байтах) буфера, на который указывает описание. В выходных данных этот параметр получает размер (в байтах) описания тега. Если тег не содержит описания, этот параметр получает значение 0.

Примечание Если параметр Description имеет значение NULL, этот параметр не получает никаких сведений. Следует задать значения Description и DescSize для значений, отличных от NULL, или задать для них значение NULL.

[out] Flags

Зарезервировано. Задайте для этого параметра значение NULL.

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

Значения HRESULT , возвращаемые этим методом, определяются в файлах winerror.h и strsafe.h. Значения, возвращаемые этим методом, включают, но не ограничиваются следующими:

Код возврата	Описание
S_OK	Этот метод успешно получил запрошенное имя или описание (или и то, и другое), и усечение запрошенной строки или строк не требовалось.
STRSAFE_E_INSUFFICIENT_BUFFER	Этот метод извлек запрошенное имя или описание (или оба), но имя или описание было усечено.
STRSAFE_E_INVALID_PARAMETER	Вызывающий объект передал по крайней мере один недопустимый параметр.