JOB-SWITCHES

#### Search Results

Search

# JOB-SWITCHES

File | 81
Op-Sys | BS2000 Note Support for z/VSE is deprecated. Support for BS2000 is also deprecated, except in conjunction with the ESM adapter. Features that are z/VSE and BS2000 specific will be removed from future releases.
Statement | `PROCESS`
Task | Query the user switches for a specified user ID. When running in single-user mode, switches belonging to your own user ID can be reset, and the job switches of the same task can also be queried, set and reset.

## Common Fields for all Operating Systems

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`ERROR-CODE` | N3 |  |  |
`ERROR-TEXT` | A58 |  |  |
`NODE` | N5 |  | D |
`NODE-NAME` | A16 |  | D |
`SYSTEM-MESSAGE-CODE` | A10 |  |  |
`SYSTEM-CODE` | B2 |  |  |
`OPTION` | A6 |  | D | Relevant when `FUNCTION=WRITE`.
`SWITCH-NUMBERS` | A64 |  | D | Relevant when `FUNCTION=WRITE`.
`SWITCH-TYPE` | A7 |  | D |
`SWITCH-VALUES` | A32 |  | D |
`USERID` | A8 |  | D | Relevant when `FUNCTION=READ`.
`FUNCTION` | A8 |  | D | Required.

## Relevant Error Codes

Code | Text | BS2000
--- | --- | ---
530 | Access denied by Security Facility | X
600 | Unknown function | X
733 | User ID does not exist | X
750 | Invalid operand within operand list | X
755 | Invalid or no `SWITCH-TYPE` specified | X
799 | Entire System Server internal error | X
983 | Function not supported by multi-user mode | X

## Field Descriptions

Field Name | Type/Length | Operating System
--- | --- | ---
`FUNCTION` | (A8) |

Specifies the function to be performed on the switches. Possible options:

Option | Explanation
--- | ---
`READ` | Read switch status.
`WRITE` | Set switches given in field `SWITCH-NUMBERS` according to `OPTION` field.

For restrictions, see the field `SWITCH-TYPE`.

Field Name | Type/Length | Operating System
--- | --- | ---
`OPTION` | (A6) |

Operation when `FUNCTION=WRITE`:

Operation | Explanation
--- | ---
`INVERT` | Invert value of the switches given in the list.
`OFF` | Set switches in the list to `OFF`.
`ON` | Set switches in the list to `ON`.

Field Name | Type/Length | Operating System
--- | --- | ---
`SWITCH-NUMBERS` | (A64) |

Relevant when `FUNCTION=WRITE`. Gives the list of switches to be handled. Each switch must be specified as a 2-digit number between `00` and `31`. There is no delimiter between switch numbers.

### Example:

The value `031229` means switches `3`, `12` and `29`.

Field Name | Type/Length | Operating System
--- | --- | ---
`SWITCH-TYPE` | (A7) |

Defines whether the switches are `USER` switches or `PROCESS` switches. Query and modification of `PROCESS` switches is only possible when the Entire System Server runs in single-user mode. The same goes for `WRITE` of `USER` switches. In multi-user mode, the function is executed by the Entire System Server server task and the switches would be set there for the user ID of the server task.

Field Name | Type/Length | Operating System
--- | --- | ---
`SWITCH-VALUES` | (A32) |

Returns the status of all switches. Possible values:

Value | Explanation
--- | ---
`N` | Switch is off.
`Y` | Switch is on.

Field Name | Type/Length | Operating System
--- | --- | ---
`USERID` | (A8) |

Valid only when `FUNCTION=READ` and `SWITCH-TYPE=USER`: user ID for which switches are to be read.

### On this page

- Common Fields for all Operating Systems
- Relevant Error Codes
- Field Descriptions