loadStringA 函式 (winuser.h)

發行項
09/27/2022

從與指定模組相關聯的可執行檔載入字串資源，並將字串複製到具有終止 Null 字元的緩衝區，或傳回字串資源本身的唯讀指標。

語法

int LoadStringA(
  [in, optional] HINSTANCE hInstance,
  [in]           UINT      uID,
  [out]          LPSTR     lpBuffer,
  [in]           int       cchBufferMax
);

參數

[in, optional] hInstance

類型： HINSTANCE

模組實例的控制碼，其可執行檔包含字串資源。若要取得應用程式本身的控制碼，請使用Null呼叫GetModuleHandle函式。

[in] uID

類型： UINT

要載入之字串的識別碼。

[out] lpBuffer

類型： LPTSTR

如果 cchBufferMax 為非零) ，或是 cchBufferMax 為零，則為接收字串的 (緩衝區，如果 cchBufferMax 為零，則為 (字串資源本身的唯讀指標) 。長度必須足夠，才能保存指標 (8 個位元組) 。

[in] cchBufferMax

類型： int

緩衝區的大小，以字元為單位。如果字串超過指定的字元數，則會截斷字串，並以 Null 結束。如果此參數為 0， 則 lpBuffer 會收到字串資源本身的唯讀指標。

傳回值

類型： int

如果函式成功，則傳回值為下列其中一項：

如果 cchBufferMax 不是零) ，則複製到緩衝區的字元數 (，不包括終止的 Null 字元。
如果cchBufferMax為零，則 lpBuffer指向 (字串資源中的字元數) 。字串資源不保證會在模組的資源資料表中以 Null 終止，而且您可以使用此值來判斷字串資源結束的位置。
如果字串資源不存在，則為零。

若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

如果您將 0 傳遞至 cchBufferMax 以傳回 lpBuffer 參數中字串資源的唯讀指標，請使用傳回值中的字元數來判斷字串資源的長度。字串資源不保證會在模組的資源資料表中以 Null 終止。不過，資源資料表可以包含 Null 字元。字串資源會儲存在 16 個字串的區塊中，而區塊內的任何空白位置則以 Null 字元表示。

安全性備註

使用此函式不正確可能會危害應用程式的安全性。不正確的用法包括指定 nBufferMax 參數中的錯誤大小。例如，如果lpBuffer指向宣告為 TCHAR szBuffer[100] 的緩衝區szBuffer，則 sizeof (szBuffer) 會以位元組為單位提供緩衝區的大小，這可能會導致 Unicode 版本的函式緩衝區溢位。緩衝區溢位情況是應用程式中許多安全性問題的原因。在此情況下，使用 sizeof(szBuffer)/sizeof(TCHAR) 或 sizeof(szBuffer)/sizeof(szBuffer[0]) 會提供適當的緩衝區大小。

範例

如需範例，請參閱建立子視窗

注意

winuser.h 標頭會將 LoadString 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程式碼，可能會導致編譯或執行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求


最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限桌面應用程式]
目標平臺	Windows
標頭	winuser.h (包含 Windows.h)
程式庫	User32.lib
DLL	User32.dll

另請參閱

概念

其他資源

參考

字串