WsGetErrorString 函式 (webservices.h)

從錯誤物件擷取錯誤字串。

語法

HRESULT WsGetErrorString(
  [in]  WS_ERROR  *error,
  [in]  ULONG     index,
  [out] WS_STRING *string
);

參數

[in] error

包含字串的錯誤物件。

[in] index

以零起始的索引，識別要擷取的字串。 第一個錯誤字串 (索引 0) 會是最近使用 WsAddErrorString) 新增至錯誤物件 (字串。 當 錯誤 對象中出現WS_ERROR_PROPERTY_ORIGINAL_ERROR_CODE時，最後一個索引中將會提供對應的錯誤文字。

您可以使用 WS_ERROR_PROPERTY_STRING_COUNT來擷取錯誤數目。

[out] string

傳回的字串。 字串有效，直到呼叫 WsResetError 或 WsFreeError 為止。

字串不是零終止。

傳回值

此函式可以傳回下列其中一個值。

備註

字串是錯誤物件的 LANGID 屬性所指定的語言。 這可以使用 WsGetErrorProperty 搭配WS_ERROR_PROPERTY_LANGID來擷 取。

規格需求