Share via


OutputFileName 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 OutputFileName property identifies an operating system file that records job step result message text.

Syntax

object
.OutputFileName [= value]

Parts

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

  • value
    A string expression that identifies an operating system file by name

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetOutputFileName(SQLDMO_LPBSTR pRetVal);
HRESULT SetOutputFileName(SQLDMO_LPCSTR NewValue);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

SQL Server Agent can capture result message text for job steps built for the subsystems CmdExec, TSQL, and ActiveScripting.

Set OutputFileName to start recording result message text to the file indicated by the property. Set OutputFileName to an empty string to stop recording.

Applies To: