IServerEnvironment Interface

Provides access to Server configuration information.

Description

The methods of IServerEnvironment allow access to the ILog interface and the PropertySet of server configuration properties.

When To Use

Use this interface to retrieve the server properties and write access to the server logs.

Members

Name Description
Read-only property CurrentJobID Retrieves current job ID.
Read-only property JobDirectory Retrieves job directory for given job.
Read-only property JobTracker Retrieves IJobTracker interface that provides access to members that track and control execution of jobs.
Read-only property Log Retrieves an ILog interface that can be used to add logging messages.
Read-only property Properties Retrieves an IProperySet interface that provides access to the server configuration information.

IServerEnvironment.CurrentJobID Property

Retrieves current job ID.

Public ReadOnly Property CurrentJobID As String
public string CurrentJobID {get;}

IServerEnvironment.JobDirectory Property

Retrieves job directory for given job.

Public Function get_JobDirectory ( _
    ByVal JobID As String _
) As String
public string get_JobDirectory (
    string JobID
);

IServerEnvironment.JobTracker Property

Retrieves IJobTracker interface that provides access to members that track and control execution of jobs.

Public ReadOnly Property JobTracker As IJobTracker
public IJobTracker JobTracker {get;}

IServerEnvironment.Log Property

Retrieves an ILog interface that can be used to add logging messages.

Public ReadOnly Property Log As ILog
public ILog Log {get;}

IServerEnvironment.Properties Property

Retrieves an IProperySet interface that provides access to the server configuration information.

Public ReadOnly Property Properties As IPropertySet
public IPropertySet Properties {get;}

Classes that implement IServerEnvironment

Classes Description

Remarks

This interface is primarily used when developing server object extensions. It permits access to an ILog interface which provides a conduit to log messages. It also retrieves the server properties as an IPropertySet interface. This PropertySet can be used to determine various properties, for example, output and input operating system paths, that might be useful to a server object extension programmer.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.