Short Description: To define a fixed-position field and use it as an additional sort/merge field for a sort or a merge task.
Syntax
| DMXAddPositionalKey | ID starting_byte [number_of_bytes [data_format [direction [sequence] ] ] ] |
Parameters
| ID | The ID returned by DMXNew that identifies the invocation. |
| starting_byte | The starting byte position of the fixed-position field you want to use as the additional sort/merge field. The first position within the data portion of the records is byte position 1. |
| number_of_bytes | The length in bytes of the fixed-position sort/merge field. Provide a value of 0 to indicate that the field extends to the end of the record. The argument is optional and defaults to 0. |
| data_format | The format of the data stored in the field. It must be one of the standard data formats or the code generated by a call to DMXAddDatetimeFormat. The argument is optional and defaults to $DMX_DATA_CHARACTER. 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.