IDebugFAEntryTags：：GetProperties 方法（extsfns.h）

發行項
02/06/2025

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

在輸入時，此參數會指定 Name 所指向之緩衝區的大小，以位元組為單位。在輸出中，此參數會接收標籤名稱的大小，以位元組為單位。如果標籤沒有名稱，此參數會收到 0 的值。

注意如果 Name 為 NULL，則此參數不會收到任何資訊。您應該同時將 Name 和 NameSize 設為非 NULL 值，或將兩者都設定為 NULL。

[out] Description

緩衝區的指標，接收以 Null 結尾的字串，這是標記的描述。如果 DescSize 小於標記描述的長度，這個方法只會將 DescSize 位元組，包括 NULL 終止符，複製到這個緩衝區。

[in, out] DescSize

在輸入時，此參數會指定 Description 所指向之緩衝區的大小，以位元組為單位。在輸出中，此參數會接收標記描述的大小，以位元組為單位。如果標籤沒有描述，此參數會收到 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	呼叫端至少傳遞了一個無效的參數。