| NAME |
XHD DELETE PARAMETER CATEGORY |
| TAG |
DELETE |
| ROUTINE |
XHDPCAT |
| RETURN VALUE TYPE |
SINGLE VALUE |
| AVAILABILITY |
SUBSCRIPTION |
| VERSION |
.1 |
| DESCRIPTION |
This call deletes parameter categories from the M backing store. If the
second parameter, DELKIDS is passed as "1" (boolean true by M programming
convention), all descendents of the category in question will also be
deleted.
|
| INPUT PARAMETER |
-
- PCAT
- PARAMETER TYPE: LITERAL
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
This is the record number (i.e., IEN) of the parameter category to be
deleted.
-
- DELKIDS
- PARAMETER TYPE: LITERAL
- REQUIRED: NO
- SEQUENCE NUMBER: 2
- DESCRIPTION:
This boolean flag indicates whether to delete all descendents of the
parameter category in question.
|
| RETURN PARAMETER DESCRIPTION |
Error condition. Returns 0 if the category was successfully deleted, or
1^message if the call failed.
|
