Short Description: To define a delimited field and use it as an additional sort/merge field for a sort or a merge task.
Syntax
| DMXAddDelimitedKey | ID field_number [data_format [direction [sequence] ] ] |
Parameters
| ID | The ID returned by DMXNew that identifies the invocation. |
| field_number | The field number of the delimited field you want to use as an additional sort/merge field. The fields in the source record are numbered from left to right, beginning with 1. |
| data_format | The format of the data stored in the field. The argument is optional and defaults to $DMX_DATA_CHARACTER. Supported values for a delimited field are $DMX_DATA_CHARACTER, $DMX_DATA_DATE_TIME, $DMX_DATA_EDITED_NUMERIC and the code generated by a call to DMXAddDatetimeFormat. For a description, see Data format code passed to Connect ETL subroutines. |
| direction | The direction in which to order the sort/merge field. The argument is optional and defaults to $DMX_ORDER_ASCENDING. For a description, see Sort/Merge field direction code passed to Connect ETL subroutines |
| sequence | The name of the collating sequence to use when ordering the sort/merge field. The sequence can be any of the standard sequences or a special sequence defined in the data dictionary of the loaded task. The argument is optional. If not specified, the default collating sequence will be used. The sequence name must be empty for a field with data_format other than $DMX_DATA_CHARACTER. Connect ETL terminates with an error otherwise. |
Notes
You can invoke this function at any time after loading the task via DMXSetApplicationFileName and before running the task via DMXRun.
Connect ETL will terminate with an error if the loaded task is a join or copy.