ExportRange Method

Description

Exports the specified range of events to XML format.

Syntax

Visual Basic
Public Function ExportRange( _ ByVal FirstEventID As Unknown, _ ByVal LastEventID As Unknown, _ Optional ByVal DeleteEventsAfterExporting As Boolean = False _ ) As String

Visual Basic

Public Function ExportRange( _
   ByVal FirstEventID As Unknown, _
   ByVal LastEventID As Unknown, _
   Optional ByVal DeleteEventsAfterExporting As Boolean = False _
) As String

Parameters

FirstEventID: The ID of the first event that should be exported (64-bit integer).
LastEventID: The ID of the first event that should be exported (64-bit integer).
DeleteEventsAfterExporting: Boolean value of true if the exported events should be removed from the log when they are exported.

Return Type

Exported events as XML string.

Remarks

This method is available only if M-Files API is used in the server interface mode.

An XSD schema file describing the returned XML format can be found from the Common folder under the M-Files installation directory, which is by default C:\Program Files\M-Files\[version]\Common\events.xsd.

Note

The XML Schema Definition Tool can be used to generate managed .Net classes from the schema by issuing the command xsd.exe events.xsd /classes.

Note

This method requires support for 64-bit data types. Use ExportRange_32bit in development environments such as VBScript that do not support these data types.

"Development environment" should not be confused with "operating system": This method can be used in 32-bit operating systems even though it uses 64-bit data types.