Indy 9 | Content | Index | Reference

TIdSysLogMsgPart
Hierarchy, Properties, Methods, See Also, Unit: IdSysLogMessage
TIdSysLogMsgPart encapsulates the Msg part of the SysLog message.

    TIdSysLogMsgPart = class(TPersistent)

Unit
IdSysLogMessage
Description
TIdSysLogMsgPart encapsulates the Msg part of the SysLog message such as the original text message, Process name, PID, and the message content. This class allows you to parse the SysLog Msg part and create a properly formatted Msg part of the SysLog message.

TIdSysLogMsgPart.Content
TIdSysLogMsgPart, See Also
The content property is the free-form text property for the message sent by a process.

    property Content: String;

Description
The content property is the free-form text property for the message sent by a process. The value is obtained by parsing the TIdSysLogMsgPart.Text text property and setting this property will update the TIdSysLogMsgPart.Text property.

TIdSysLogMsgPart.PID
TIdSysLogMsgPart, See Also
This is the Process ID (PID) for the process that caused the SysLog message.

    property PID: Integer;

Description
This is the Process ID (PID) for the process that caused the SysLog message. This name may not be the name of the program sending the SysLog message to the server. This value is used only if TIdSysLogMsgPart.PIDAvailable property is set to true. The value is obtained by parsing the TIdSysLogMsgPart.Text text property and setting this property will update the TIdSysLogMsgPart.Text property.

TIdSysLogMsgPart.PIDAvailable
TIdSysLogMsgPart, See Also
This property indicates if a PID is available in the Text form of the Msg.

    property PIDAvailable: Boolean;

Description
This property indicates if a PID is available in the Text form of the Msg. Setting this to True will cause the PID value to be included in the text form of the Msg or setting this to false will remove the PID from the Text form of the Msg. A PID may not be included if it is not applicable to the computer or if the PID would be meaningless (e.g. the process by it's nature runs briefly such as SU). The value is obtained by parsing the TIdSysLogMsgPart.Text text property and setting this property will update the TIdSysLogMsgPart.Text property.

TIdSysLogMsgPart.Process
TIdSysLogMsgPart, See Also
This is the name of the process that caused the SysLog message.

    property Process: String;

Description
This is the name of the process that caused the SysLog message. This name may not be the name of the program sending the SysLog message to the server. The value is obtained by parsing the TIdSysLogMsgPart.Text text property and setting this property will update the TIdSysLogMsgPart.Text property.

TIdSysLogMsgPart.Text
TIdSysLogMsgPart, See Also
This is the raw text form of the SysLog Msg.

    property Text: String;

Description
This is the raw text form of the SysLog Msg. Setting this property will update the TIdSysLogMsgPart.Process, TIdSysLogMsgPart.PIDAvailable, TIdSysLogMsgPart.PID, and TIdSysLogMsgPart.Content properties to reflect the appropriate values and likewise, setting the properties mentioned will update this property.

TIdSysLogMsgPart.Assign
TIdSysLogMsgPart
Copies property values from a persistent source.

    procedure Assign(Source: Tpersistent); override;

Description
Assign is a procedure that allows property values for the current object instance to be copied from the persistent component specified in Source. When Source is an instance of TIdSysLogMsgPart, the value for the Text property is updated from the value in Source. Otherwise, the inherited Assign method is called.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.