Function
The //DELETE-DOCUMENTATION statement is used to delete documentation lines for message units. The documented messages are selected using the message code.
Differences compared with the //DELETE-DOCUMENTATION statement in menu mode
The //DELETE-DOCUMENTATION statement which can be entered in the command area of the screen mask differs from the //DELETE-DOCUMENTATION statement in command procedures in that in menu mode, the operand value *PANEL-REQUEST can be assigned to any operand.
For further details, see section “Special features of statements in menu mode”.
Format
DELETE-DOCUMENTATION | ||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||
Operands
MSG-ID = *ALL / *CLASS(...) / *INTERVAL(...) / <name 7..7>
Name of one or more message units whose documentation is to be deleted.
MSG-ID = *ALL
All documentation lines of the currently open message file will be deleted.
MSG-ID = *CLASS(...)
MSG-CLASS = <name 3..3>
The documentation lines which were written for the messages of the message class specified here will be deleted.
MSG-ID = *INTERVAL(...)
The documentation lines which were written for the messages of the range indicated here will be deleted. The limit values of the range must belong to the same message class.
FROM = <name 7..7>
Designates the lower limit value of the message range (full message code).
TO = <name 7..7>
Designates the upper limit value of the message range (full message code).
DELETE-SUBSETS = *NO / *YES
Enables precise determination of the documentation lines to be deleted which are defined in this message range.
DELETE-SUBSETS = *NO
Only those documentation lines will be deleted which were defined precisely for the message range designated by FROM, TO. The message range is documented in an allocation.
Example
//ADD-DOCUMENTATION MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0020),
OWNER=*PARAMETERS(NAME='Smith', TEAM='TST0815'),
COMMENTS='documentation for messages AAA0001 to AAA0020'
//DELETE-DOCUMENTATION MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0020,
DELETE-SUBSETS=NO)
DELETE-SUBSETS = *YES
All documentation lines are deleted that lie within the message range defined by FROM and TO. The message range is documented via several allocations.
Example
//ADD-DOCUMENTATION MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0008),
OWNER=*PARAMETERS(NAME='Smith', TEAM='TST0815'),
COMMENTS='documentation for messages AAA0001 to AAA0008'
//ADD-DOCUMENTATION MSG-ID=AAA0010, OWNER=*PARAMETERS(NAME='Smith',
TEAM='TST0815'), COMMENTS='documentation for message AAA0010'
//ADD-DOCUMENTATION MSG-ID=*INTERVAL(FROM=AAA0015,TO=AAA0019),
OWNER=*PARAMETERS(NAME='Smith', TEAM='TST0815'),
COMMENTS='documentation for messages AAA0015 to AAA0019'
//DELETE-DOCUMENTATION MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0020,
DELETE-SUBSETS=*YES)
MSG-ID = <name 7..7>
The documentation for the full message code designated here will be deleted.
//ADD-DOCUMENTATION MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0020),
OWNER=*PARAMETERS(NAME='Smith', TEAM='TST0815'),
COMMENTS='documentation for messages AAA0001 to AAA0020'
//DELETE-DOCUMENTATION MSG-ID=*INTERVAL(FROM=AAA0001,TO=AAA0020,
DELETE-SUBSETS=NO)