GetComputerNameA 関数 (winbase.h)

ローカル コンピューターの NetBIOS 名を取得します。 この名前は、システムがレジストリから読み取るときに、システムの起動時に確立されます。

GetComputerName は、ローカル コンピューターの NetBIOS 名のみを取得します。 DNS ホスト名、DNS ドメイン名、または完全修飾 DNS 名を取得するには、 GetComputerNameEx 関数を呼び出します。 追加情報は、 IADsADSystemInfo インターフェイスによって提供されます。

ローカル コンピューターがクラスター内のノードである場合、この関数の動作が影響を受ける可能性があります。 詳細については、「 ResUtilGetEnvironmentWithNetName 」および「 UseNetworkName」を参照してください。

構文

BOOL GetComputerNameA(
  [out]     LPSTR   lpBuffer,
  [in, out] LPDWORD nSize
);

パラメーター

[out] lpBuffer

コンピューター名またはクラスター仮想サーバー名を受け取るバッファーへのポインター。 バッファー サイズは、MAX_COMPUTERNAME_LENGTH + 1 文字を含むのに十分な大きさにする必要があります。

[in, out] nSize

入力時に、バッファーのサイズを TCHAR で指定します。 出力時に、宛先バッファーにコピーされた TCHAR の 数 。終端の null 文字は含まれません。

バッファーが小さすぎると、関数は失敗し、 GetLastError は ERROR_BUFFER_OVERFLOWを返します。 lpnSize パラメーターは、終端の null 文字を含め、必要なバッファーのサイズを指定します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

GetComputerName 関数は、システムの起動時に確立された NetBIOS 名を取得します。 SetComputerName 関数または SetComputerNameEx 関数によって行われた名前の変更は、ユーザーがコンピューターを再起動するまで有効になりません。

呼び出し元がクライアント セッションで実行されている場合、この関数はサーバー名を返します。 クライアント名を取得するには、 WTSQuerySessionInformation 関数を使用します。

例

例については、「 システム情報の取得」を参照してください。

要件

関連項目

コンピューター名

GetComputerNameEx

SetComputerName

SetComputerNameEx

システム情報関数