Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 3.07 KB

xp-logevent-transact-sql.md

File metadata and controls

94 lines (63 loc) · 3.07 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
xp_logevent (Transact-SQL)
Logs a user-defined message in the SQL Server log file and in the Windows Event log.
MashaMSFT
mathoma
randolphwest
03/07/2025
sql
system-objects
reference
xp_logevent
xp_logevent_TSQL
xp_logevent
TSQL

xp_logevent (Transact-SQL)

[!INCLUDE SQL Server]

Logs a user-defined message in the [!INCLUDE ssNoVersion] log file and in the Windows Event log. xp_logevent can be used to send an alert without sending a message to the client.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

xp_logevent { error_number , 'message' } [ , 'severity' ]

Arguments

[!INCLUDE extended-stored-procedures]

error_number

A user-defined error number larger than 50000. The maximum value is 2147483647 (2^31 - 1).

'message'

A character string with a maximum of 2048 characters.

'severity'

One of three character strings: INFORMATIONAL, WARNING, or ERROR. severity is optional, with a default of INFORMATIONAL.

Return code values

0 (success) or 1 (failure).

Result set

xp_logevent returns the following error message for the included code example:

The command(s) completed successfully.

Remarks

When you send messages from [!INCLUDE tsql] procedures, triggers, batches, and so on, use the RAISERROR statement instead of xp_logevent. xp_logevent doesn't call a message handler of a client, or set @@ERROR. To write messages to the Windows Event log and to the [!INCLUDE ssNoVersion] error log file within an instance of [!INCLUDE ssNoVersion], execute the RAISERROR statement.

Permissions

Requires membership in the db_owner fixed database role in the master database, or membership in the sysadmin fixed server role.

Examples

The following example logs the message, with variables passed to the message in the Windows Event Viewer.

DECLARE @@TABNAME VARCHAR(30),
    @@USERNAME VARCHAR(30),
    @@MESSAGE VARCHAR(255);

SET @@TABNAME = 'customers';
SET @@USERNAME = USER_NAME();

SELECT @@MESSAGE = 'The table ' + @@TABNAME + ' is not owned by the user
   ' + @@USERNAME + '.';

USE master;

EXEC xp_logevent 60000, @@MESSAGE, informational;

Related content