| |
| META TOPICPARENT |
name="CDChartDirectorDesignerAPI" |
Key Concepts |
| |
The API's usually have one or more required parameters and possibly one more optional parameters. If you fail to PASS a required parameter, the API will CANCEL with a error message indicating which parameter is missing. When PASSing optional parameters, you may have to PASS dummy parameters to fill in any gaps. For example, if an API takes 3 optional parameters, and you want to PASS the a value to the second parameter, then you will have to PASS something for the first optional parameter, then then value you want for the second parameter. Otherwise, the API will associate your value with the first optional parameter, not the second. |
|
>
> | The parameters for the API's are case insensitive, so TOPLEFT is the same as tOpLeFt or tOPLEFt. |
| | For every API, there is a work field of the same name that will contain any return codes from the API. You can test this work field for a non blank value after returning to see if an error occurred. The work fields are tokenized, so you can SCAN the possible values in the ILF editor.
The API names begin with a period to distinguish the external routines from the internal ones. You will notice a number of other subroutines in the 0CD application that do not begin with a period. These are the internal subroutines used by the API itself, do not try to call them directly. |
Copyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.