Partager via


Fonction RasAdminGetErrorString

[Cette fonction est fournie uniquement pour la compatibilité descendante avec Windows NT Server 4.0. Il retourne ERROR_CALL_NOT_IMPLEMENTED sur Windows Server 2003. Les applications doivent utiliser la fonction MprAdminGetErrorString .]

La fonction RasAdminGetErrorString récupère une chaîne de message qui correspond à un code d’erreur RAS retourné par l’une des fonctions d’administration du serveur RAS (RasAdmin). Ces chaînes de message sont récupérées à partir du Rasmsg.dll installé dans le cadre de RAS.

Syntaxe

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

Paramètres

ResourceId [in]

Spécifie un code d’erreur retourné par l’une des fonctions RasAdmin. Cette valeur doit se trouver dans la plage de codes d’erreur de RASBASE à RASBASEEND. Elles sont définies dans Raserror.h.

lpszString [out]

Pointeur vers une mémoire tampon qui reçoit le message d’erreur correspondant au code d’erreur spécifié.

InBufSize [in]

Spécifie la taille, en caractères, de la mémoire tampon lpszString . Les messages d’erreur font généralement 80 caractères ou moins ; une taille de mémoire tampon de 512 caractères est toujours suffisante.

Valeur retournée

Si la fonction réussit, la valeur de retour est ERROR_SUCCESS.

Si la fonction échoue, la valeur de retour est un code d’erreur. Cette valeur peut être une dernière valeur d’erreur définie par les fonctions LoadLibrary, GlobalAlloc ou LoadString ; ou il peut s’agir de l’un des codes d’erreur suivants.

Valeur Signification
ERROR_INVALID_PARAMETER
Les paramètres ResourceId ou lpszString ne sont pas valides.
ERROR_INSUFFICIENT_BUFFER
La taille spécifiée par le paramètre InBufSize est trop petite.

Il n’existe aucune information d’erreur étendue pour cette fonction ; n’appelez pas GetLastError.

Notes

Les fonctions RasAdmin peuvent retourner des codes d’erreur qui ne se trouvent pas dans la plage prise en charge par la fonction RasAdminGetErrorString . Par exemple, les fonctions RasAdmin peuvent retourner des codes d’erreur définis dans Lmerr.h et Winerror.h. Avant d’appeler RasAdminGetErrorString, vérifiez que le code d’erreur se trouve dans la plage RASBASE à RASBASEEND, comme défini dans Raserror.h.

Spécifications

Condition requise Valeur
Fin de la prise en charge des clients
Windows 2000 Professionnel
Fin de la prise en charge des serveurs
Windows 2000 Server
En-tête
Rassapi.h
Bibliothèque
Rassapi.lib
DLL
Rassapi.dll

Voir aussi

Vue d’ensemble du service d’accès à distance (RAS)

Fonctions d’administration du serveur RAS

LoadLibrary

GlobalAlloc

LoadString