ILog.AddMessage Method

Adds a message to the log.

[Visual Basic .NET]
Public Sub AddMessage ( _
    ByVal msgType As Integer, _
    ByVal msgCode As Integer, _
    ByVal msg As String _
)

[C#]
public void AddMessage (
    int msgType,
    int msgCode,
    string msg
);

[C++]
HRESULT AddMessage(
  long msgType,
  long msgCode,
  BSTR msg
);

[C++]
Parameters
msgType [in]

  msgType is a parameter of type long
msgCode [in]

  msgCode is a parameter of type long
msg [in]

  msg is a parameter of type BSTR

Product Availability

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.

See Also