sp_altermessage (Transact-SQL)sp_altermessage (Transact-SQL)

APLICA-SE A: simSQL Server nãoBanco de Dados SQL do Azure nãoAzure Synapse Analytics (SQL DW) nãoParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

Altera o estado de mensagens definidas pelo usuário ou do sistema em uma instância do Mecanismo de Banco de Dados do SQL ServerSQL Server Database Engine.Alters the state of user-defined or system messages in an instance of the Mecanismo de Banco de Dados do SQL ServerSQL Server Database Engine. As mensagens definidas pelo usuário podem ser exibidas usando a exibição do catálogo Sys. messages .User-defined messages can be viewed using the sys.messages catalog view.

Ícone de link do tópico Convenções de sintaxe de Transact-SQLTopic link icon Transact-SQL Syntax Conventions

SintaxeSyntax

  
sp_altermessage [ @message_id = ] message_number   ,[ @parameter = ]'write_to_log'  
   ,[ @parameter_value = ]'value'   

ArgumentosArguments

[ @message_id = ] message_number[@message_id = ] message_number
É o número do erro da mensagem a ser alterado de Sys. messages.Is the error number of the message to alter from sys.messages. message_number é int sem valor padrão.message_number is int with no default value.

[ @parameter = ] 'write\_to\_log_' é usado com @parameter_value para indicar que a mensagem deve ser gravada no log do aplicativo do Windows MicrosoftMicrosoft.[ @parameter = ] 'write\_to\_log_' Is used with @parameter_value to indicate that the message is to be written to the MicrosoftMicrosoft Windows application log. write_to_log é sysname sem valor padrão.write_to_log is sysname with no default value. write_to_log deve ser definido como WITH_LOG ou nulo.write_to_log must be set to WITH_LOG or NULL. Se write_to_log for definido como WITH_LOG ou NULL e o valor de @parameter_value for true, a mensagem será gravada no log de aplicativos do Windows.If write_to_log is set to WITH_LOG or NULL, and the value for @parameter_value is true, the message is written to the Windows application log. Se write_to_log for definido como WITH_LOG ou NULL e o valor de @parameter_value for false, a mensagem nem sempre será gravada no log de aplicativos do Windows, mas poderá ser gravada dependendo de como o erro foi gerado.If write_to_log is set to WITH_LOG or NULL and the value for @parameter_value is false, the message is not always written to the Windows application log, but may be written depending upon how the error was raised. Se write_to_log for especificado, o valor para @parameter_value também deverá ser especificado.If write_to_log is specified, the value for @parameter_value must also be specified.

Observação

Se uma mensagem for gravada no log do aplicativo do Windows, ela também será gravada no arquivo de log de erros do Mecanismo de Banco de DadosDatabase Engine.If a message is written to the Windows application log, it is also written to the Mecanismo de Banco de DadosDatabase Engine error log file.

[ @parameter_value = ]'value_' é usado com @parâmetro para indicar que o erro deve ser gravado no log do aplicativo do Windows MicrosoftMicrosoft.[ @parameter_value = ]'value_' Is used with @parameter to indicate that the error is to be written to the MicrosoftMicrosoft Windows application log. o valor é varchar (5) , sem valor padrão.value is varchar(5), with no default value. Se for true, o erro será sempre gravado no log de aplicativos do Windows.If true, the error is always written to the Windows application log. Se for false, o erro nem sempre será gravado no log de aplicativos do Windows, mas poderá ser gravado dependendo de como o erro foi gerado.If false, the error is not always written to the Windows application log, but may be written depending upon how the error was raised. Se Value for especificado, write_to_log para @parâmetro também deverá ser especificado.If value is specified, write_to_log for @parameter must also be specified.

Valores do código de retornoReturn Code Values

0 (êxito) ou 1 (falha)0 (success) or 1 (failure)

Conjuntos de resultadosResult Sets

Nenhum.None

RemarksRemarks

O efeito de sp_altermessage com a opção with_log é semelhante ao do parâmetro RAISERROR com log, exceto que sp_altermessage altera o comportamento de log de uma mensagem existente.The effect of sp_altermessage with the WITH_LOG option is similar to that of the RAISERROR WITH LOG parameter, except that sp_altermessage changes the logging behavior of an existing message. Se uma mensagem foi alterada para ser WITH_LOG, ela sempre será gravada no log de aplicativos do Windows, independentemente de como um usuário invocar o erro.If a message has been altered to be WITH_LOG, it is always written to the Windows application log, regardless of how a user invokes the error. Até mesmo se RAISERROR for executado sem a opção WITH_LOG, o erro será gravado no log de aplicativos do Windows.Even if RAISERROR is executed without the WITH_LOG option, the error is written to the Windows application log.

As mensagens do sistema podem ser modificadas usando sp_altermessage.System messages can be modified by using sp_altermessage.

PermissõesPermissions

Requer a associação na função de servidor fixa ServerAdmin .Requires membership in the serveradmin fixed server role.

ExemplosExamples

O exemplo a seguir faz com que a mensagem 55001 existente seja registrada no log de aplicativos do Windows.The following example causes existing message 55001 to be logged to the Windows application log.

EXECUTE sp_altermessage 55001, 'WITH_LOG', 'true';  
GO  

Consulte tambémSee Also

RAISERROR (Transact-SQL) RAISERROR (Transact-SQL)
sp_addmessage (Transact-SQL) sp_addmessage (Transact-SQL)
sp_dropmessage (Transact-SQL) sp_dropmessage (Transact-SQL)
Procedimentos armazenados do sistema (Transact-SQL)System Stored Procedures (Transact-SQL)