• Article

AgentLogFile Property

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The AgentLogFile property specifies the SQL Server Agent log path and file name.

Syntax

object.AgentLogFile [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    A string that specifies the path and file name

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetAgentLogFile(SQLDMO_LPBSTR pRetVal);
HRESULT SetAgentLogFile(SQLDMO_LPCSTR NewValue);

Remarks

By default, the SQL Server Agent log is stored as c:\\Program Files\Microsoft SQL Server\90\mssql90\Log\\Sqlagent.out. Use the AgentLogFile property to specify a location other than the default when running multiple instances of SQL Server Agent.

Note

AgentLogFile can be used with SQL Server version 7.0 and later.

Applies To:

Registry2 Object