HSaveParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

Managing databases

HFSQL functions

HFSQL Client/Server functions

Prefix syntax

WLanguage procedure

HSaveParameter

Presentation

Example

Type of variables saved

See also

HAddGroup

HAddLink

HAddScheduledBackup

HAddScheduledOptimization

HAddScheduling

HAddTask

HAddUser

HBackup

HCS.FrameSize (Variable)

HCS.Timeout (Variable)

HCancelBackup

HChangePassword

HCheckServerUpdate

HClearWorkingDir

HConnectionQuality

HCopyFile (Example)

HCopyFile

HDeleteBackup

HDeleteDatabase

HDeleteDirectory

HDeleteFile

HDeleteGroup

HDeleteLink

HDeleteParameter

HDeleteQuery

HDeleteScheduledBackup

HDeleteScheduledOptimization

HDeleteScheduling

HDeleteSet

HDeleteTask

HDeleteUser

HDisconnectClient

HDropView

HDuplicateDatabase

HEndNoDatabaseAccess

HExecuteProcedure

HExecuteScheduledBackup

HExecuteScheduling

HInfoBackup

HInfoDatabaseProperty

HInfoDatabaseRights (Example)

HInfoDatabaseRights

HInfoFileProperty

HInfoFileRights (Example)

HInfoFileRights

HInfoGroup

HInfoLock

HInfoLog

HInfoServer

HInfoServerProperty

HInfoServerRights (Example)

HInfoServerRights

HInfoTask

HInfoUser

HInfoView

HInfoViewRights

HListConnectedUser

HListDatabase

HListGroup

HListParameter

HListScheduledBackup

HListScheduledOptimization

HListScheduling

HListServer

HListStoredElement

HListTask

HListUser

HLoadParameter

HManageServerUpdate

HManageTask

HModifyDatabaseProperty

HModifyDatabaseRights

HModifyFileProperty

HModifyFileRights

HModifyGroup

HModifyScheduledBackup

HModifyScheduledOptimization

HModifyScheduling

HModifyServerProperty

HModifyServerRights

HModifyTask

HModifyUser

HModifyViewRights

HNoDatabaseAccess

HNotifAddCCRecipient

HNotifAddEmailRecipient

HNotifConfigure

HNotifDeleteCCRecipient

HNotifDeleteEmailRecipient

HNotifListCCRecipient

HNotifListEmailRecipient

HOnServerCall

HOperationInProgress

HPriority

HPriorityClient

HReconnect

HResetClient

HResetGroup

HResetUser

HRestoreBackup (Example)

HRestoreBackup

HRetrieveBackup

HRetrieveLog

HSaveParameter

HSendMessageToClient

HServerMaintenance

HServerStatus

HServerWorkingDir

HSetCache

HSetServer

HSimulateNetwork

HStartServer

HStartServerUpdate

HStopServer

HSuggestKey

HSuggestKeyEnd

HSuggestKeyStart

HTrack

HTrackStop

HTransactionRollbackToSavepoint

HTransactionSavepoint

HUpdateLink

HUpdateQuery

HUpdateSet

HUpdateView

hServerOperation

Type of variables saved

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HSaveParameter (Function)

In french: HSauveParamètre

Available only with this kind of connection

Saves a persistent value. This value can be read by HLoadParameter.

Remark: The parameters are saved by database in the "user_param.fic" file.

Example

// Save a value from a stored procedure
// (Server code)
HSaveParameter("MyParameter", 5)

Syntax

Saving a parameter on the server (in the code of stored procedure) Hide the details

<Result> = HSaveParameter(<Parameter> , <Parameter value>)

<Result>: Boolean

True if the backup was performed,
False if an error occurred. HErrorInfo is used to identify the error.

<Parameter>: Character string

Name of the parameter to be saved. This parameter must not correspond to an empty string and it must not contain the "CR" character (Carriage return).

<Parameter value>: Type corresponding to the value to save

Value to save.

Saving a parameter on the server (from the Client computer) Hide the details

<Result> = HSaveParameter(<Connection> , <Parameter> , <Parameter value>)

<Result>: Boolean

True if the backup was performed,
False if an error occurred. HErrorInfo is used to identify the error.

<Connection>: Character string 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 variable of type Connection.

<Parameter>: Character string

Name of the parameter to be saved. This parameter must not correspond to an empty string and it must not contain the "CR" character (Carriage return).

<Parameter value>: Type corresponding to the value to save

Value to save.

Remarks

Type of variables saved

HSaveParameter is used to save the simple variables (string, integer, ...).

To save complex variables (objects, structures, etc.), these variables must be serialized as strings using Serialize.

Component: wd270hf.dll