RasAdminGetErrorString 関数

  • [アーティクル]

[この関数は、Windows NT Server 4.0 との下位互換性のためにのみ提供されます。 Windows Server 2003 でERROR_CALL_NOT_IMPLEMENTEDを返します。 アプリケーションでは MprAdminGetErrorString 関数を使用する必要があります。]

RasAdminGetErrorString 関数は、RAS サーバー管理 (RasAdmin) 関数の 1 つによって返される RAS エラー コードに対応するメッセージ文字列を取得します。 これらのメッセージ文字列は、RAS の一部としてインストールされているRasmsg.dllから取得されます。

構文

DWORD RasAdminGetErrorString(
  _In_  UINT  ResourceId,
  _Out_ WCHAR *lpszString,
  _In_  DWORD InBufSize
);

パラメーター

ResourceId [in]

RasAdmin 関数の 1 つによって返されるエラー コードを指定します。 この値は、RASBASE から RASBASEEND までのエラー コードの範囲内である必要があります。 これらは Raserror.h で定義されています。

lpszString [out]

指定したエラー コードに対応するエラー メッセージを受け取るバッファーへのポインター。

InBufSize [in]

lpszString バッファーのサイズを文字数で指定します。 エラー メッセージは通常 80 文字以下です。バッファー サイズは常に 512 文字で十分です。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値はエラー コードです。 この値には、 LoadLibrary、 GlobalAlloc、または LoadString 関数によって設定された最後のエラー値を指定できます。または、次のいずれかのエラー コードを指定できます。

値 説明
ERROR_INVALID_PARAMETER
 ResourceId パラメーターまたは lpszString パラメーターが無効です。
ERROR_INSUFFICIENT_BUFFER
 InBufSize パラメーターで指定されたサイズが小さすぎます。

この関数の拡張エラー情報はありません。 GetLastError を呼び出さないでください。

解説

RasAdmin 関数は、 RasAdminGetErrorString 関数でサポートされている範囲内にないエラー コードを返すことができます。 たとえば、RasAdmin 関数は、Lmerr.h および Winerror.h で定義されているエラー コードを返すことができます。 RasAdminGetErrorString を呼び出す前に、Raserror.h で定義されているように、エラー コードが RASBASE から RASBASEEND の範囲にあることを確認します。

必要条件

要件 値
クライアント サポートの終了
 Windows 2000 Professional
サーバー サポートの終了
 Windows 2000 Server
Header
Rassapi.h
ライブラリ
Rassapi.lib
[DLL]
Rassapi.dll

関連項目

リモート アクセス サービス (RAS) の概要

RAS サーバー管理機能

Loadlibrary

GlobalAlloc

LoadString