次の方法で共有

RasGetErrorStringA 関数 (ras.h)

  • [アーティクル]

RasGetErrorString 関数は、指定された RAS エラー値のエラー メッセージ文字列を取得します。

構文

DWORD RasGetErrorStringA(
  [in]  UINT  ResourceId,
  [out] LPSTR lpszString,
  [in]  DWORD InBufSize
);

パラメーター

[in] ResourceId

対象のエラー値を指定します。 RAS 関数のいずれかによって返される値です。RasError.h ヘッダー ファイルに記載されている値です。

[out] lpszString

エラー文字列を受け取るバッファーへのポインター。 このパラメーターは NULLすることはできません。

[in] InBufSize

lpszErrorStringが指すバッファーのサイズ 文字数で指定します。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラー コード、または Routing と Remote Access Error Codes または Winerror.h からの値です。 RasGetErrorString 関数によって設定された GetLastError 情報 はありません。

価値 意味
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。

備考

エラー メッセージの正確なサイズを事前に判断する方法はありません。したがって、必要なバッファーのサイズです。 通常、エラー メッセージのサイズは 80 文字以下です。バッファー サイズは常に 512 文字で十分です。 バッファーのサイズが不十分な場合、RasGetErrorString 関数 が失敗し、ERROR_INSUFFICIENT_BUFFERが返されます。 バッファー サイズはバイトではなく文字で指定されることに注意してください。したがって、RasGetErrorString の Unicode バージョンでは、すべてのエラー メッセージが収まることを保証するために、少なくとも 1024 バイトのバッファーが必要です。

例

次のコードは、RAS エラー 633 のエラー文字列を取得します。


#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include "rasdlg.h"
#include <tchar.h>

#define  ERROR_VAL 633
#define  BUFFER_SIZE 256

DWORD __cdecl wmain(){

    DWORD dwRetVal = ERROR_SUCCESS;
    UINT  uErrorValue = ERROR_VAL;
    DWORD cBufSize = BUFFER_SIZE;
    WCHAR lpszErrorString[BUFFER_SIZE];

    dwRetVal = RasGetErrorString(uErrorValue, lpszErrorString, cBufSize);

    if(dwRetVal == ERROR_SUCCESS){
        wprintf(L"Error Code %d: %s\n", uErrorValue, lpszErrorString);
    }else{
           wprintf(L"RasGetErrorString failed, Return Value: %d", dwRetVal);
    }

    return 0;
}

手記

ras.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RasGetErrorString を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされる最小サーバー Windows 2000 Server [デスクトップ アプリのみ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー ras.h
ライブラリ Rasapi32.lib
DLL Rasapi32.dll

関連項目

GlobalAlloc

LoadString

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

リモート アクセス サービス関数 の