<Connection variable>.RetrieveLog (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

HFSQL Client/Server functions

Format of the lines in the text file

See also

ActivateServerTrigger

AddGroup

AddLink

AddScheduledBackup

AddScheduledOptimization

DeactivateServerTrigger

DeleteScheduledBackup

DeleteScheduledOptimization

DescribeServerTrigger

ExecuteScheduledBackup

ListScheduledOptimization

ModifyDatabaseProperty

ModifyScheduledBackup

ModifyScheduledOptimization

NotifAddEmailRecipient

NotifConfigure

NotifDeleteCCRecipient

NotifDeleteEmailRecipient

NotifListCCRecipient

NotifListEmailRecipient

Format of the lines in the text file

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Connection variable>.RetrieveLog (Function)

In french: <Variable Connexion>.RécupèreLog

Available only with this kind of connection

Creates a text file containing the server logs between two given dates.

Remark: This function is an advanced function. Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Example

// Describe the connection
MyConnection is Connection

// Retrieve the server logs for 2018
IF MyConnection.RetrieveLog("20180101", "20183112", "C:\My Documents\MyLogs.txt") = False THEN
Error("The logs have not been retrieved: " + HError())
END

// Describe the connection
MyConnection is Connection

// Retrieve the server logs for 2018
IF MyConnection.RetrieveLog("20180101", "20183112", "\My Documents\MyLogs.txt") = False THEN
Error("The logs have not been retrieved: " + HError())
END

Syntax

<Result> = <Connection>.RetrieveLog(<Start date> , <End date> , <Destination Log file> [, <Progress Bar>])

<Result>: Boolean

True if the logs have been retrieved,
False otherwise. HError is used to identify the error.

<Connection>: Connection variable

Name of the Connection variable that describes the connection to the server from which the logs must be retrieved.

<Start date>: Character strings with quotes

Date from which the server logs must be retrieved. This date is in "YYYYMMDDHHmmSSCCC" format. If only the date is specified ("YYYYMMDD"), it will be rounded up automatically. For example, "20061121" will be rounded to "20061121000000000".

<End date>: Character string with quotes

Date until which the server logs must be retrieved. This date is in "YYYYMMDDHHmmSSCCC" format. If only the date is specified ("YYYYMMDD"), it will be rounded up automatically. For example, "20061121" will be rounded to "20061121235959999".

<Destination Log file>: Character string (with quotes)

Text file into which will be written the content of the server log between the two dates. If this file already exists, it will be overwritten.

<Progress Bar>: Optional control name, optional window name or optional integer

Versions 21 and later
Progress Bar:
Name of window where the progress bar will be displayed or name of Progress Bar control.
Identifier (Handle) of window that displays the progress bar.
This parameter is ignored.
New in version 21
Progress Bar:
Name of window where the progress bar will be displayed or name of Progress Bar control.
Identifier (Handle) of window that displays the progress bar.
This parameter is ignored.
Progress Bar:
Name of window where the progress bar will be displayed or name of Progress Bar control.
Identifier (Handle) of window that displays the progress bar.
This parameter is ignored.

Remarks

Format of the lines in the text file

The lines in the text file have the following format:

For a call:

<Line Size> + TAB + <Type> + TAB + <Call Identifier> + TAB + <Date> + TAB +
<Thread Identifier> + TAB + <Context Identifier> + TAB + <Login> + TAB +
<Client Computer> + TAB + <Client Application> + TAB + <Application Version> + TAB +
<Function Number> + TAB + <Parameters>
For the end of a call:

<Line Size> + TAB + <Type> + TAB + <Call Identifier> + TAB +
<Date> + TAB + <Context Identifier> + TAB + <Parameters>

Where:

<Line size> is a 8-character hexadecimal number used to define the size of the line for the logs, the 8 characters not being taken into account in the specified size.
<Type> can take the following values:
- 1: Beginning of function
- 2: End of function
- 3: Error
<Date> is in the format YYYYMMDDHHmmSSCCC
<Parameters> has the following format:
- <Identifier du parameter 1> + "=" + <Value of parameter 1> + Charact(0) + Charact(255) +
- <Identifier of parameter 2> + "=" + <Value of parameter 2> + Charact(0) + Charact(255) + ... +
- <Identifier of parameter N> + "=" + <Value of parameter N> + Charact(0)

Component: wd260hf.dll