Description
Sets a DataSet Object property; the DataSet Object is specified by the passed handle.
Syntax
flag = DSSetProperty (hDS, property, value, arg)
Parameters
The DSSetProperty function has the following parameters:
| Parameter | Description |
|---|---|
| hDS | Handle to the DataSet. |
| property | See properties below. |
| value | Property specific; see properties below. |
| Arg | Property specific; see properties below. |
| Property | Description | Value | Argument |
|---|---|---|---|
| DS_ARG$ | Sets the current value for the specified argument. | value[in] | Argument value (@FM-delimited list). |
| arg[in] | Argument ID. | ||
| DS_CONNECTION$ | Sets the Connection Object that the DataSet uses. | arg[in] | A valid Connection Object handle or 0 (none). |
| DS_DELETE_SCRIPT$ | Sets the DataSet's delete script. | value[in] | DataSet's delete script. |
| DS_DFT_ISNULL$ | Sets the specified default column to null. | arg[in] | Column ID. |
| DS_DFT_ROW$ | Sets the default row using the specified conversion (defaults to OI conversion). | value[in] | Row of @FM-delimited data. |
| arg[in] | [Conversion]. | ||
| DS_DFT_VALUE$ | Sets the default column value for the specified column optionally using the specified conversion. | value[in] | Column value. |
| arg[in] | Column ID [@FM conversion]. | ||
| DS_INSERT_SCRIPT$ | Sets the DataSet's insert script. | value[in] | DataSet's insert script. |
| DS_ISNULL$ | Sets the specified column to null. | A | An @FM-delimited list of null flags. |
| arg[in] | Column [@FM rowtype]. | ||
| DS_KEYLIST$ | Filters the current view by specifying the keys of the rows to keep in the current view. The DS_KEYLIST$ property provides a simple way to store a filtered view of a keyed DataSet by getting the current list of keys using DSGetProperty(DS_KEYLIST$) and later using DSSetProperty(DS_KEYLIST$) to restore the filter. | value[in] | An @fm-delimited list of keys to leave in the view; multiple columns are delimited by @vm if more than one column is used as the key. This is an identical format to the list returned by DSGetProperty(DS_KEYLIST$). |
| arg[in] | ResetFilterFirst :@fm: IgnoreMissingKeys. Pass ResetFilterFirst as TRUE to reset the filter before applying the DS_KEYLIST$ (defaults to FALSE). Pass IgnoreMissingKeys as FALSE to return an error if all of the keys are not found or TRUE to ignore missing keys (defaults to FALSE) | ||
| DS_ROW$ | Sets a row of data, either the current row (default), the default row, or the workspace row, using either the OI conversion (default) or any other specified conversion. | value[in] | Row of @FM-delimited data. |
| arg[in] | [Conversion [@FM rowtype]]. | ||
| DS_ROWID$ | Sets the current row in the DataSet. | value[in] | Current row index (1-based). |
| arg[in] | TRUE$ for relative positioning, FALSE$ (default) for absolute. | ||
| DS_SCRIPT$ | Sets the specified script to the passed value. | arg[in] | Script ID (defaults to SELECT). |
| DS_SELECT_SCRIPT$ | Sets the DataSet's select script. | value[in] | DataSet's select script. |
| DS_UPDATE_SCRIPT$ | Sets the DataSet's update script. | value[in] | DataSet's s update script. |
| DS_VALUE$ | Sets a column's value optionally using a specified conversion (defaults to OI conversion) and rowtype (defaults to a DataSet row). bBlankIsNull sets column to NULL if value is blank and the column is nullable. Overwrite forces each column to be modified even if it has not changed. | value[in] | @ FM-delimited list of column values. |
| arg[in] | Column ID [@FM conversion [@FM rowtype [@FM bBlankIsNull @VM bOverwrite]]]. | ||
| DS_VIEW$ | Sets the current view (master, select, insert, update, delete) of the DataSet. | value[in] | View ID (master, select, insert, update, delete). |
| DS_WORK_ISNULL$ | Sets the specified workspace column to null. | arg[in] | Column ID. |
| DS_WORK_ROW$ | Sets the workspace row using the specified conversion (defaults to OI conversion). | value[in] | Row of @FM-delimited data. |
| arg[in] | [Conversion]. | ||
| DS_WORK_VALUE$ | Sets the workspace column value for the specified column optionally using the specified conversion. | value[in] | @FM-delimited list of column values. |
| arg[In] | Column ID [@FM conversion]. |
Column and argument parameters are permitted to be either name or position (number). In addition, DSSetProperty supports @VM lists of column or argument names/positions to be passed or 0 to signify all.
Returns
True for successful execution or False for failure.
