getUserNameA 函式 (winbase.h)

  • 發行項

擷取與目前線程相關聯的用戶名稱。

使用 GetUserNameEx 函式，以指定的格式擷取使用者名稱。 IADsADSystemInfo 介面會提供其他資訊。

語法

BOOL GetUserNameA(
  [out]     LPSTR   lpBuffer,
  [in, out] LPDWORD pcbBuffer
);

參數

[out] lpBuffer

要接收使用者登入名稱之緩衝區的指標。 如果這個緩衝區不夠大，無法包含整個用戶名稱，則函式會失敗。 (UNLEN + 1) 字元的緩衝區大小會保留最大長度的用戶名稱，包括終止的 Null 字元。 UNLEN 定義於 Lmcons.h 中。

[in, out] pcbBuffer

在輸入時，此變數會在 TCHAR 中指定 lpBuffer 緩衝區的大小。 在輸出時，變數會接收複製到緩衝區的 TCHAR 數目，包括終止的 Null 字元。

如果 lpBuffer 太小，函式會失敗，而且 GetLastError 會傳回ERROR_INSUFFICIENT_BUFFER。 此參數會接收必要的緩衝區大小，包括終止的 Null 字元。

傳回值

如果函式成功，傳回值是非零值，而 lpnSize 所指向的變數會包含複製到 lpBuffer 所指定之緩衝區的 TCHAR 數目，包括終止的 Null 字元。

如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

如果目前的線程正在模擬另一個用戶端， GetUserName 函式會傳回線程正在模擬之客戶端的用戶名稱。

如果從在 「NETWORK SERVICE」 帳戶下執行的進程呼叫 GetUserName ， 則 lpBuffer 中傳回的字串可能會因 Windows 版本而異。 在 Windows XP 上，會傳回「網路服務」字串。 在 Windows Vista 上，會傳回 “<HOSTNAME>$” 字串。

範例

如需範例，請參閱 取得系統資訊。

注意

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

規格需求

需求 值
最低支援的用戶端 Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 winbase.h (包含 Windows.h)
程式庫 Advapi32.lib
Dll Advapi32.dll

另請參閱

GetUserNameEx

LookupAccountName

系統資訊函式