GetStringTypeA 函式 (winnls.h)

  • 發行項

已取代。 擷取指定來源字串中字元的字元類型資訊。 針對字串中的每個字元，函式會在輸出數位的對應16位元素中設定一或多個位。 每個位都會識別指定的字元類型，例如字母、數位或兩者都未識別。

謹慎 使用 GetStringTypeA 函式不正確可能會危害應用程式的安全性。 若要避免緩衝區溢位，應用程式必須正確設定輸出緩衝區大小。 如需詳細資訊，請參閱 安全性考慮：Windows 用戶介面。

 

語法

BOOL GetStringTypeA(
  [in]  LCID   Locale,
  [in]  DWORD  dwInfoType,
  [in]  LPCSTR lpSrcStr,
  [in]  int    cchSrc,
  [out] LPWORD lpCharType
);

參數

[in] Locale

指定地區設定的地區設定識別碼。 您可以使用 MAKELCID 宏來建立地區設定標識碼，或使用下列其中一個預先定義的值。

Windows Vista 和更新版本： 也支援下列自定義地區設定標識碼。

[in] dwInfoType

旗標，指定要擷取的字元類型資訊。 如需可能的旗標值，請參閱 GetStringTypeW 的 dwInfoType 參數。 如需字元類型位的詳細資訊，請參閱 GetStringTypeW 的。

[in] lpSrcStr

要擷取字元類型的 ANSI 字串指標。 如果提供的地區設定適用於 DBCS，字串可以是雙位元組位元集， (DBCS) 字串。 如果 cchSrc 設定為任何負值，字串會假設為 null 終止。

[in] cchSrc

lpSrcStr 所指示字串的大小，以字元為單位。 如果大小包含終止 Null 字元，函式會擷取該字元的字元類型資訊。 如果應用程式將大小設定為任何負整數，則會假設來源字串為 Null 終止，而且函式會自動以額外的字元計算 Null 終止的大小。

[out] lpCharType

16 位值的陣列指標。 此陣列的長度必須夠大，才能針對來源字串中的每個字元接收一個16位值。 如果 cchSrc 不是負數， lpCharType 應該是具有 cchSrc 元素的字組陣列。 如果 cchSrc 設定為負數， lpCharType 是具有 lpSrcStr + 1 個元素的單字數位。 當函式傳回時，此陣列會包含一個對應至來源字串中每個字元的字組。

傳回值

如果成功，則傳回非零值，否則傳回 0。 若要取得延伸的錯誤資訊，應用程式可以呼叫 GetLastError，這可以傳回下列其中一個錯誤碼：

  • ERROR_INVALID_FLAGS。 為旗標的值無效。
  • ERROR_INVALID_PARAMETER。 任何參數值都無效。

備註

如需字串函式使用概觀，請參閱 字串。

此函式會將來源字串轉換成 Unicode，並呼叫對應的 GetStringTypeW 函式。 因此，輸出緩衝區中的單字不會對應至原始 ANSI 字串，而是對應至其 Unicode 對等專案。 從 ANSI 轉換為 Unicode 可能會導致字串長度變更，例如，一對 ANSI 字元可以對應至單一 Unicode 字元。 因此，輸出緩衝區中的單字與原始 ANSI 字串中的字元之間的對應在所有情況下都不是一對一，例如多位元組字串。 因此 ，GetStringTypeA 對多字元字串的使用有限。 建議改用 GetStringTypeW 函式和 GetStringTypeEx。

當此函式搭配僅限 Unicode 的地區設定識別碼使用時，函式可能會成功，因為作業系統使用系統代碼頁。 不過，系統代碼頁中未定義的字元會出現在字串中，以問號 (？) 。

lpSrcStr 和 lpCharType 參數的值不得相同。 如果相同，函式會失敗，並ERROR_INVALID_PARAMETER。

Locale 參數僅用於執行 Unicode 的字串轉換。 它與應用程式所提供的 CTYPE* 值無關。 這些值只由 Unicode 字碼點決定，而且不會因地區設定而有所不同。 例如，希臘文字母會指定為 地區設定的任何值C1_ALPHA。

對應的 GetStringTypeW 函式不會使用 Locale 參數。 由於參數差異，應用程式無法透過使用 #define UNICODE 參數，自動叫用適當的 ANSI 或 Unicode 版本的 GetStringType* 函式。 應用程式可以使用 GetStringTypeEx 來規避這項限制，這是建議的函式。

規格需求

需求 值
最低支援的用戶端 Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
目標平台 Windows
標頭 winnls.h (包含 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

GetStringTypeEx

GetStringTypeW

國家語言支援

國家語言支援函式