HRetrieveLog (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

Management of databases

HFSQL functions

HFSQL Client/Server functions

HRetrieveLog

Presentation

Example

Format of the lines in the text file

HAddScheduledOptimization

HCS.Timeout (Variable)

HDeleteScheduledBackup

HDeleteScheduledOptimization

HExecuteScheduledBackup

HExecuteScheduling

HInfoBackup

HInfoDatabaseProperty

HListScheduledOptimization

HModifyDatabaseProperty

HModifyDatabaseRights

HModifyFileProperty

HModifyFileRights

HModifyGroup

HModifyScheduledBackup

HModifyScheduledOptimization

HModifyScheduling

HModifyServerProperty

HNotifAddEmailRecipient

HNotifConfigure

HNotifDeleteCCRecipient

HNotifDeleteEmailRecipient

HNotifListCCRecipient

HNotifListEmailRecipient

Format of the lines in the text file

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HRetrieveLog (Function)

In french: HRécupèreLog

Available only with this kind of connection

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

Note: This function is an advanced function.

Note: From version 19, HFSQL is the new name of HyperFileSQL.

Example

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

// Retrieve the server logs for 2006
IF HRetrieveLog("MyConnection", "20060101", "20063112", "\My Documents\MyLogs.txt") = False THEN
Error("The logs have not been retrieved: " + HError())
END

Syntax

<Result> = HRetrieveLog(<Connection Name> , <Start Date> , <End Date> , <Destination File> [, <Progress bar>])

<Result>: Boolean

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

<Connection Name>: Character string

Name of 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 YYYYMMDDHHMMSSMMM 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 YYYYMMDDHHMMSSMMM format. If only the date is specified ("YYYYMMDD"), it will be rounded up automatically. For example, "20061121" will be rounded to "20061121235959999".

<Destination 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 character string (with or without quotes) 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> has the following format: YYYYMMDDHHMMSSCCm
<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 : wd240hf.dll