DicomObjects.NET Core Documentation
DicomObjects Namespace / DicomGlobal Class / LogToFile Method / LogToFile(String,Int32,Int32) Method

The location of the log files.

If an empty string being passed, DicomObjects will use "C:\" as the default location.

But still it is the container's responsibility to ensure either that the path is valid and correct.

This value controls the level of details logged either to the display, or to a file.

The allowable values for log level are:

Decimal Hex
1 1 Errors
2 2 Warnings
4 4 Informational Messages
8 8 Detailed Logging
16 10 All DICOM attributes received or read
32 20 All DICOM attributes send or written
64 40 Byte-Level data received, except contents of data PDUs
128 80 Byte-level data sent, except contents of data PDUs
256 100 All bytes received
512 200 All bytes sent

RestartMinutes as int, the time interval when a new log file should be generated.




In This Topic
    LogToFile(String,Int32,Int32) Method
    In This Topic
    Enables DicomObjects logging, specifies where DicomObjects log files appear, what the logging level is and the timer interval when new log file should be generated.
    Syntax
    'Declaration
     
    
    Public Overloads Shared Sub LogToFile( _
       ByVal Path As String, _
       ByVal LogLevel As Integer, _
       ByVal RestartMinutes As Integer _
    ) 
    'Usage
     
    
    Dim Path As String
    Dim LogLevel As Integer
    Dim RestartMinutes As Integer
     
    DicomGlobal.LogToFile(Path, LogLevel, RestartMinutes)
    public static void LogToFile( 
       string Path,
       int LogLevel,
       int RestartMinutes
    )
    public:
    static void LogToFile( 
       String^ Path,
       int LogLevel,
       int RestartMinutes
    ) 

    Parameters

    Path

    The location of the log files.

    If an empty string being passed, DicomObjects will use "C:\" as the default location.

    But still it is the container's responsibility to ensure either that the path is valid and correct.

    LogLevel

    This value controls the level of details logged either to the display, or to a file.

    The allowable values for log level are:

    Decimal Hex
    1 1 Errors
    2 2 Warnings
    4 4 Informational Messages
    8 8 Detailed Logging
    16 10 All DICOM attributes received or read
    32 20 All DICOM attributes send or written
    64 40 Byte-Level data received, except contents of data PDUs
    128 80 Byte-level data sent, except contents of data PDUs
    256 100 All bytes received
    512 200 All bytes sent
    RestartMinutes

    RestartMinutes as int, the time interval when a new log file should be generated.

    Remarks

    The last two levels should NOT be used routinely when images are being sent or received, as the quality of log data becomes unmanageable, and the system will probably run so slowly that connecting equipment will time-out.

    Other bits in the higher word are reserved for Medical Connections' use or future expansion.

    This overload is to provide users a means to restart the logging on a regular time basic. This method is useful to avoid log file end up being HUGE.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also