The ADD_SUSPEND call
ADD_SUSPEND acquires a suspend token that can later be used to identify a SUSPEND/RESUME pair.
ADD_SUSPEND
DFHDSSRX [CALL,]
[CLEAR,]
[IN,
FUNCTION(ADD_SUSPEND),
[RESOURCE_NAME(name16 | string | 'string'),]
[RESOURCE_TYPE(name8 | string | 'string'),]]
[OUT,
SUSPEND_TOKEN(name4 | (Rn)),
RESPONSE(name1 | *),
REASON(name1 | *)]
This command is threadsafe.
- RESOURCE_NAME(name16 | string | "string")
- specifies a 16-character string that can be used to document and trace
the resource involved in suspend and resume processing. You cannot use register
notation to specify the address of the string.
- name16
- The name of the location where a 16-byte value is stored.
- string
- A string of characters without intervening blanks; if it is not 16 bytes long, it is extended with blanks or truncated as required.
- "string"
- A string of characters enclosed in quotation marks. Blanks are permitted in the enclosed string. If you want to document a name (label) in your program, use this form.
Note: RESOURCE_NAME on ADD_SUSPEND supplies a default value which is used if RESOURCE_NAME is not specified on a SUSPEND call. - RESOURCE_TYPE(name8 | string | "string")
- specifies an 8-character string that can be used to document and trace
the resource involved in suspend and resume processing. You cannot use register
notation to specify the address of the string.
- name8
- The name of the location where an 8-byte value is stored.
- string
- A string of characters without intervening blanks; if it is not 8 bytes long, it is extended with blanks or truncated as required.
- "string"
- A string of characters enclosed in quotation marks. Blanks are permitted in the enclosed string. If you want to document a name (label) in your program, use this form.
Note: RESOURCE_TYPE on ADD_SUSPEND supplies a default value which is used if RESOURCE_TYPE is not specified on a SUSPEND call. - SUSPEND_TOKEN(name4 | (Rn))
- returns a token assigned by the system to identify the SUSPEND/RESUME
pair of operations used on the task.
- name4
- The name of a 4-byte field where the token is stored
- (Rn)
- A register into which the token value is loaded.
RESPONSE and REASON values for ADD_SUSPEND
| RESPONSE | REASON |
|---|---|
| OK | None |
| EXCEPTION | None |
| DISASTER | None |
| INVALID | None |
| KERNERROR | None |
| PURGED | None |
Note: For more detail, refer to the explanation of RESPONSE and REASON
in Making an XPI call.