TFormer_SetDSParameterValue
Provide Data · String encodings
Definition
Windows: ANSI; Unix: UTF-8
ERRCODE TFormer_SetDSParameterValue(HTFORM pInstance, LPCSTR pszParameterName, LPCSTR pszValue);
Windows only: UTF-16
ERRCODE TFormer_SetDSParameterValueW(HTFORM pInstance, LPCWSTR pszParameterName, LPCWSTR pszValue);Contract
Specifies the value of a DataSourceParameter.
Use this function to specify a value for a DataSourceParameter. A DataSourceParameter may be defined by the user with TFORMer Designer and can be used to control certain aspects of a DataSource during runtime (e.g. filenames, SQL statement or an ODBC-DSN).
Returns
- ErrOk (0) in case of success, non-zero if an error occurred
Parameters
| Parameter / type | Description |
|---|---|
pInstanceHTFORM |
|
pszParameterNameLPCSTR / LPCWSTR |
|
pszValueLPCSTR / LPCWSTR |
|
Note
Must be called before TFormer_Print, but after TFormer_SetDatasourceName or if a parameter of the active Datasource should be set, after TFormer_SetFormName.