srv_message_handler (API de procédure stockée étendue)

S'applique à : SQL Server

Important

Cette fonctionnalité sera supprimée dans une version future de SQL Server. Évitez d'utiliser cette fonctionnalité dans de nouveaux travaux de développement, et prévoyez de modifier les applications qui utilisent actuellement cette fonctionnalité. Utilisez plutôt l'intégration du CLR.

Appelle le gestionnaire de messages de l'API de procédure stockée étendue installée. Cette fonction est généralement utilisée pour appeler Microsoft SQL Server à partir d’une procédure stockée étendue pour consigner une erreur (définie par la procédure stockée étendue) dans le fichier journal des erreurs SQL Server ou le journal des applications Microsoft Windows.

Syntaxe

  
int srv_message_handler (  
SRV_PROC *  
srvproc  
,  
int  
errornum  
,  
BYTE   
severity  
,  
BYTE  
state  
,  
int  
oserrnum  
,  
char *  
errtext  
,  
int  
errtextlen  
,  
char *  
oserrtext  
,  
int  
oserrtextlen  
);  

Arguments

srvproc
Pointeur vers la structure SRV_PROC qui est le handle pour une connexion cliente particulière. Le paramètre srvproc contient des informations utilisées pour gérer les communications et les données entre l’application et le client.

errornum
Numéro d'erreur défini par la procédure stockée étendue. Ce nombre doit être compris entre 50 001 et 2 147 483 647.

severity
Valeur de gravité SQL Server standard pour l’erreur. Ce nombre doit être compris entre 0 et 24.

state
Valeur d’état SQL Server pour l’erreur.

oserrnum
Numéro d'erreur du système d'exploitation. Cet argument est ignoré.

errtext
Description de l’erreur de la procédure stockée étendue errornum.

errtextlen
Longueur de la chaîne d’erreur de la procédure stockée étendue errtext.

oserrtext
Description de l’erreur du système d’exploitation oserrnum. Cet argument est ignoré.

oserrtextlen
Longueur de la chaîne d’erreur du système d’exploitation oserrtext.

Retours

SUCCEED ou FAIL.

Notes

La fonction srv_message_handler permet à une procédure stockée étendue de s’intégrer aux fonctionnalités centralisées de journalisation des erreurs et de création de rapports de SQL Server. Les alertes SQL Server peuvent être établies pour les événements provenant de procédures stockées étendues, et SQL Server Agent surveille ces conditions d’alerte.

Si le message d'erreur est plus long, il est tronqué à 412 octets.

Important

Il est préférable d'examiner avec soin le code source des procédures stockées étendues et de tester les DLL compilées avant de les installer sur un serveur de production. Pour plus d'informations sur l'examen et les tests de sécurité, consultez ce site Web de Microsoft.