|
|
|
|
|
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 e-mail: the server to be configured is an SMTP server.
- Via the Control Centers (WDBal messaging tool). The Control Centers can use an HFSQL Classic database or an HFSQL Client/Server database.
cnxConnexionCS is Connection
cnxConnexionCS.Provider = hAccessHFClientServer
cnxConnexionCS.User = "admin"
cnxConnexionCS.MotDePasse = ""
cnxConnexionCS.Server = "test:4900"
HOpenConnection(cnxConnexionCS)
HNotifConfigure(cnxConnexionCS, hNotifCCCS, "DOC:4988", "CC_DOC", "DOC", "")
cnxConnexionCS is Connection
cnxConnexionCS.Provider = hAccessHFClientServer
cnxConnexionCS.User = "admin"
cnxConnexionCS.MotDePasse = ""
cnxConnexionCS.Server = "test:4900"
HOpenConnection(cnxConnexionCS)
HNotifConfigure(cnxConnexionCS, hNotifEmail, "FLEUR:25", "test.doc", "doc", "doc@pcsoft.com", False)
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 or Connection variable Connection to use. This connection corresponds to: <Type of notifications>: Integer constant Type of sending: | | hNotifEmail | The notifications are sent by email. |
<SMTP server>: Character string DNS name or IP address of email server (outgoing protocol). This IP address is supplied by the service provider or by the network administrator. Warning: It is necessary to use the SMTP server of the Internet connection provider. <Login>: Character string Login used to connect to the SMTP server. <Password>: Optional string or Secret string 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. New in version 2025Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string". To learn more about secret strings and how to use the vault, see Secret string vault. <Sender>: Character string 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 or Connection variable Connection to use. This connection corresponds to: <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 DNS name or IP address of the HFSQL server hosting the Control Centers. <Control Center Database>: Character string Name of the database used for the Control Centers. <Login>: Character string Login used to connect to the HFSQL server and to the database of Control Centers. <Password>: Character string or Secret string Password associated with the connection login. If this parameter is not specified, the former value is automatically used.
New in version 2025Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string". To learn more about secret strings and how to use the vault, see Secret string vault.
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 or Connection variable Connection to use. This connection corresponds to: <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 Access path to the HFSQL Classic data files of Control Centers. <Login>: Character string Login used to connect to the database of Control Centers. <Password>: Character string or Secret string Password associated with the connection login. If this parameter is not specified, the former value is automatically used.
New in version 2025Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string". To learn more about secret strings and how to use the vault, see Secret string vault.
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 or Connection variable Connection to use. This connection corresponds to: <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. |
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|