HNotifConfigure (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

HFSQL Client/Server functions

HAddScheduledOptimization

HCS.FrameSize (Variable)

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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HNotifConfigure (Function)

In french: HNotifConfigure

Available only with this kind of connection

Specifies and configures the server used to send notifications by the HFSQL server. This sending can be performed:

By email: the server to configure is a SMTP server.
Via the Control Centers (WDBal messaging tool). The Control Centers can use a HFSQL Classic database or a HFSQL Client/Server database.

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

Example

ctCSConnection is Connection
ctCSConnection..Provider = hAccessHFClientServer
ctCSConnection..User = "admin"
ctCSConnection..Password = ""
ctCSConnection..Server = "test:4900"
HOpenConnection(ctCSConnection)

HNotifConfigure(ctCSConnection, hNotifCCCS, "DOC:4988", "CC_DOC", "DOC", "")

Syntax

Configuring the sending of emails via a SMTP server Hide the details

<Result> = HNotifConfigure(<Connection> , <Type of notifications> , <SMTP server> , <Login> [, <Password>] , <Sender> , <Secure Session>)

<Result>: Boolean

True if the configuration was performed.
False otherwise. HErrorInfo is used to identify the error.

<Connection>: Character string (with or without quotes) or Connection variable

Connection to use. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.

<Type of notifications>: Integer constant

Type of sending:
hNotifEmail The notifications are sent by email.

<SMTP server>: Character string (with quotes)

DNS name or IP address of email server (outgoing protocol). This IP address is supplied by the service provider or by the network administrator.
Caution: You must use the SMTP server of the provider of Internet connection.

<Login>: Character string (with quotes)

Login used to connect to the SMTP server.

<Password>: Optional character string (with quotes)

Password associated with the connection login on the SMTP server. This password is given by the service provider or by the network administrator.
If this parameter is not specified, the former value is automatically used.

<Sender>: Character string (with quotes)

Email address used as sender in the notification emails.

<Secure Session>: Boolean

True to start a session secured by the TLS protocol.
False otherwise.

Configuring the sending of messages in WDBal (Control Centers in Client/Server) Hide the details

<Result> = HNotifConfigure(<Connection> , <Type of notifications> , <Control Center Server> , <Control Center Database> , <Login> [, <Password>])

<Result>: Boolean

True if the configuration was performed.
False otherwise. HErrorInfo is used to identify the error.

<Connection>: Character string (with or without quotes) or Connection variable

Connection to use. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.

<Type of notifications>: Integer constant

Type of sending:
hNotifCCCS The notifications are sent by the Control Centers in Client/Server mode.

<Control Center Server>: Character string (with quotes)

DNS name or IP address of the HFSQL server hosting the Control Centers.

<Control Center Database>: Character string (with quotes)

Name of the database used for the Control Centers.

<Login>: Character string (with quotes)

Login used to connect to the HFSQL server and to the database of Control Centers.

<Password>: Character string (with quotes)

Password associated with the connection login.
If this parameter is not specified, the former value is automatically used.

Configuring the sending of messages in WDBal (Control Centers in HFSQL Classic) Hide the details

<Result> = HNotifConfigure(<Connection> , <Type of notifications> , <Control Center Path> , <Login> [, <Password>])

<Result>: Boolean

True if the configuration was performed.
False otherwise. HErrorInfo is used to identify the error.

<Connection>: Character string (with or without quotes) or Connection variable

Connection to use. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.

<Type of notifications>: Integer constant

Type of sending:
hNotifCCClassic The notifications are sent by the Control Centers in HFSQL Classic mode.

<Control Center Path>: Character string (with quotes)

Access path to the HFSQL Classic data files of Control Centers.

<Login>: Character string (with quotes)

Login used to connect to the database of Control Centers.

<Password>: Character string (with quotes)

Password associated with the connection login.
If this parameter is not specified, the former value is automatically used.

Retrieving the parameters of the current configuration Hide the details

<Result> = HNotifConfigure(<Connection> , <Type of notifications>)

<Result>: Character string

List of parameters corresponding to the requested configuration (caution, the passwords are not supplied).
The result has the following format:
with the hNotifCCClassic constant: <Control Centre Path> + CR + <Login>
with the hNotifCCCS constant: <Control Center Server> + CR + <Control Center Database> + CR + <Login>
with the hNotifEmail constant: <SMTP server> + CR + <Login> + CR + <Sender> + CR + <Secure session>

<Connection>: Character string (with or without quotes) or Connection variable

Connection to use. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.

<Type of notifications>: Integer constant

Type of sending for which the configuration is requested:
hNotifCCClassic The notifications are sent by the Control Centers in HFSQL Classic mode.
hNotifCCCS The notifications are sent by the Control Centers in HFSQL Client/Server mode.
hNotifEmail The notifications are sent by email.

Component: wd260hf.dll