Fungsi RasGetErrorStringA (ras.h)

Fungsi RasGetErrorString mendapatkan string pesan kesalahan untuk nilai kesalahan RAS tertentu.

Sintaks

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

Parameter

[in] ResourceId

Menentukan nilai kesalahan yang menarik. Ini adalah nilai yang dikembalikan oleh salah satu fungsi RAS: yang tercantum dalam file header RasError.h.

[out] lpszString

Penunjuk ke buffer yang menerima string kesalahan. Parameter ini tidak boleh NULL.

[in] InBufSize

Menentukan ukuran, dalam karakter, dari buffer yang ditujukkan oleh lpszErrorString.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah ERROR_SUCCESS.

Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut atau nilai dari Kode Kesalahan Perutean dan Akses Jarak Jauh atau Winerror.h. Tidak ada informasi GetLastError yang ditetapkan oleh fungsi RasGetErrorString .

Nilai	Makna
ERROR_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi.

Keterangan

Tidak ada cara untuk menentukan terlebih dahulu ukuran yang tepat dalam karakter pesan kesalahan, dan dengan demikian ukuran buffer yang diperlukan. Pesan kesalahan umumnya akan berukuran 80 karakter atau kurang; ukuran buffer 512 karakter akan selalu memadai. Buffer dengan ukuran yang tidak mencukup menyebabkan fungsi RasGetErrorString gagal, mengembalikan ERROR_INSUFFICIENT_BUFFER. Perhatikan bahwa ukuran buffer ditentukan dalam karakter, bukan byte; dengan demikian, rasGetErrorString versi Unicode memerlukan setidaknya buffer byte 1024 untuk menjamin bahwa setiap pesan kesalahan cocok.

Contoh

Kode berikut mendapatkan string kesalahan untuk kesalahan 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;
}

Catatan

Header ras.h mendefinisikan RasGetErrorString sebagai alias yang secara otomatis memilih versi ANSI atau Unicode dari fungsi ini berdasarkan definisi konstanta preprosektor UNICODE. Mencampur penggunaan alias encoding-netral dengan kode yang tidak mengodekan-netral dapat menyebabkan ketidakcocokan yang mengakibatkan kesalahan kompilasi atau runtime. Untuk informasi selengkapnya, lihat Konvensi untuk Prototipe Fungsi.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Target Platform	Windows
Header	ras.h
Pustaka	Rasapi32.lib
DLL	Rasapi32.dll

Lihat juga

GlobalAlloc

LoadString

Gambaran Umum Layanan Akses Jarak Jauh (RAS)

Fungsi Layanan Akses Jarak Jauh