ILogSupport Interface

Provides access to methods for initializing an object for logging.

Description

If you want your server object extension to log messages to the GIS server's log file, your server object extension should implement ILogSupport. ILogSupport is an optional interface for server object extensions that has a single InitLogging method. InitLogging is called when the server object extension is created and hands back a reference to the GIS server's log object via the log argument. Once you have a reference to the server log, you will often call a single method, AddMessage(), to add information to the log. The AddMessage() method has three parameters: level, code, and message.

The level is the level of detail of the message in relation to other messages. Levels are classified from 1 to 5 and termed, in order, Error, Warning, Normal, Detailed, and Debug. ArcGIS for Server log file settings determine which messages are included in the server log.

The code is the result code associated with the message. The code is an arbitrary integer value to uniquely define the source of the message. Codes 0 - 5999 are utilized by the SOM. Codes 6000 and above can be generated by any serviced component (e.g. MapServer, GeocodeServer, custom component, etc.).

The message is the custom string inserted into the GIS server log file.

Members

Name Description
Method InitLogging Initializes an object with a log.

ILogSupport.InitLogging Method

Initializes an object with a log.

Public Sub InitLogging ( _
    ByVal Log As ILog _
)
public void InitLogging (
    ILog Log
);

Description

If you want your server object extension to log messages to the GIS server's log file, your server object extension should implement ILogSupport. ILogSupport is an optional interface for server object extensions that has a single InitLogging method. InitLogging is called when the server object extension is created and hands back a reference to the GIS server's log object via the log argument. Once you have a reference to the server log, you will often call a single method, AddMessage(), to add information to the log. The AddMessage() method has three parameters: level, code, and message.

The level is the level of detail of the message in relation to other messages. Levels are classified from 1 to 5 and termed, in order, Error, Warning, Normal, Detailed, and Debug. ArcGIS for Server log file settings determine which messages are included in the server log.

The code is the result code associated with the message. The code is an arbitrary integer value to uniquely define the source of the message. Codes 0 - 5999 are utilized by the SOM. Codes 6000 and above can be generated by any serviced component (e.g. MapServer, GeocodeServer, custom component, etc.).

The message is the custom string inserted into the GIS server log file.

Classes that implement ILogSupport

Classes Description
GeometryServer (esriGeoDatabase) Provides access to standard operations on geometric 'value' objects. The input geometries are never modified by these operations. Designed for use in building web services and web applications.
GeometryServerImpl (esriGeometry) Provides access to standard operations on geometric 'value' objects. The input geometries are never modified by these operations. Designed for use in building web services or other kinds of distributed applications.
ImageServer (esriCarto) The ArcGIS Server Image Server class.
MapServer (esriCarto) The MapServer component provides programmatic access to the contents of a map document on disk, and creates images of the map contents based on user requests. Designed for use in building map-based web services and web applications.
WFSServer (esriGeoDatabaseDistributed) The WFS Server Object Extension.

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