RC Command: Release Command ID or Global Format ID

#### Search Results

Search

# RC Command: Release Command ID or Global Format ID

The RC command releases one or more command IDs or a global format ID for the issuing user.

We recommend that you set unused ACB and ACBX fields to binary zeros before the direct call is initiated.

This document covers the following topics:

- Function and Use

- ACB Interface Direct Call: RC Command

- ACBX Interface Direct Call: RC Command

## Function and Use

The RC command may be used to release one or more command IDs currently assigned to a user, or to delete one or all global format IDs, as follows:

- Internal format buffer pool command IDs. Related internal formats are also released;

- ISN list (TBI) command IDs;

- Command IDs in the table of sequential commands (TBLES/TBQ);

- Command IDs equal to and greater than the specified command ID value in either the internal format buffer pool or the TBI, TBLES and TBQ, or both;

- One special global format ID for a user group;

- All existing global format IDs.

If no selective options are specified, the entered command ID is released from all of the above areas. When a command ID is released, its related TBI or TBLES/TBQ entries are also removed; however, the internal format buffer pool entry is not necessarily released.

The RC command should be used under the following conditions:

- The user has completed processing an ISN list stored on the Adabas Work by an Sx command that specified the save-ISN-list option. Issuing the RC command permits Adabas to reuse the space currently occupied by the list;

- The user wishes to terminate a sequential pass of a file (using an L2/L5, L3/L6, or L9 command) before reaching an end-of-file condition;

- The user has completed a series of L1/L4, A1/A4, or N1/N2 commands in which a non-blank command ID was used.

## ACB Interface Direct Call: RC Command

This section describes ACB interface direct calls for the RC command. It covers the following topics:

- Control Block and Buffer Information

- Control Block Field Descriptions

- ACB Examples

### Control Block and Buffer Information

#### Control Block

Field | Position | Format | Before Adabas Call | After Adabas Call
--- | --- | --- | --- | ---
| 1-2 | -- | -- | --
Command Code | 3-4 | alphanumeric | F | U
Command ID | 5-8 | alphanumeric | F | U
File Number | 9-10 | binary | F | U
Response Code | 11-12 | binary | -- | A
| 13-34 | -- | -- | --
Command Option 1 | 35 | alphanumeric | F | U
Command Option 2 | 36 | alphanumeric | F | U
Additions 1 | 37-44 | alphanumeric | F | U
| 45-64 | -- | -- | --
Additions 5 | 65-72 | alphanumeric | F | U
Command Time | 73-76 | binary | -- | A
User Area | 77-80 | -- | -- | U

#### Buffer Areas

None used.

where:

F | Supplied by user before Adabas call
A | Supplied by Adabas
U | Unchanged after Adabas call
-- | Not used

### Control Block Field Descriptions

We recommend that you set unused ACB fields to binary zeros before the direct call is initiated.

> Command Code (ACBCMD)

>   RC

> Command ID (ACBCID)

>   The command ID to be released or to be used as a reference is specified in this field. A value of blanks or binary zeros releases all the command IDs currently assigned to the user.

> File Number (ACBFNR)

>   If the Command Option 1 field is set to D, E, or O, the file number field must contain the binary number of the file associated with the format or global format ID to be released.

>   For physical direct calls, specify the file number as follows:

>   - For a one-byte file number, enter the file number in the rightmost byte (10); the leftmost byte (9), should be set to binary zero (B'0000 0000').

>   - For a two-byte file number, use both bytes (9 and 10) of the field.

>   Note
>   When using two-byte file numbers and database IDs, a X'30' must be coded in the first byte of the control block.

> Response Code (ACBRSP)

>   Adabas returns the response code for the command in this field. Response code 0 (ADARSP000) indicates that the command was executed successfully. Non-zero response codes, which can also have accompanying subcodes returned in the rightmost half of the Additions 2 field, are described in the Adabas Messages and Codes Manual documentation.

> Command Option 1/2: Type of Command IDs to Be Released (ACBCOP1 and ACBCOP2)

>   These fields are used to indicate that a command ID, format ID, or global format ID is to be released from the internal format buffer pool, the ISN list table (TBI), or the table of sequential commands (TBLES/TBQ). For information about the tables, see the section General Programming Considerations.

>   If both Command Option 1/2 fields are set to blanks or binary zeros, the command ID specified in the command ID field is released from all tables in which it is present.

>   If either Command Option field is set to one of the following values, the resources associated with the command ID, format ID, or global format ID are released as indicated:

>   Option | Releases . . .
>   --- | ---
>   C | all existing global formats
>   D | all formats for a given file number and descriptor name
>   E | all global formats for a given file number and descriptor name
>   F | the format associated with the specified command ID
>   G | all existing formats associated with command IDs greater than or equal to the specified command ID
>   I | the ISN list (TBI) associated with the specified command ID
>   L | the global format ID contained in the Additions 5 field.
>   O | the global format ID contained in the Additions 5 field for a given file number.
>   S | the sequential commands (TBLES/TBQ) associated with the specified command ID
>   X | all ISN lists (TBI) and sequential commands (TBLES/TBQ) associated with command IDs that are greater than or equal to the specified command ID. Internal formats are not released.

>   Options D and E are used when the format was created by an L3 or L6 command to ensure the return of correct data in an environment where Smith/Jones problems are possible. The underlying format identifier in these cases is 12 bytes: an 8-byte format ID, a 2-byte file number, and a 2-byte descriptor name.

> Additions 1: Descriptor Name (ACBADD1)

>   If Command Option D or E is specified, the first two bytes of the Additions 1 field must contain the alphanumeric descriptor field name associated with the format or global format ID to be released. All remaining positions must be set to blanks.

>   If the format to be released was not created using the L3 or L6 command, this field is not used.

> Additions 5: Released Global Format ID (ACBADD5)

>   In this field, specify a global format ID to be released.

### ACB Examples

- Example 1
- Example 2
- Example 3
- Example 4
- Example 5

#### Example 1

The command ID "0003" is to be released.

#### Control Block

Command Code | RC |
Command ID | X'0003' | command ID 003 to be released
Command Option 1/2 | bb (blanks) | all CID types to be released

#### Example 2

All command IDs currently assigned to the user are to be released.

#### Control Block

Command Code | RC |
Command ID | X'00000000' | binary zeros indicate that all command IDs are to be released
Command Option 1/2 | bb (blanks) | all CID types to be released

#### Example 3

All the command IDs assigned to the user and contained in the table of sequential commands or the internal format buffer pool are to be released.

#### Control Block

Command Code | RC |
Command ID | X'00000000' | binary zeros indicate that all command IDs are to be released
Command Option 1 | F | F indicates that command IDs contained in the internal format buffer pool are to be released
Command Option 2 | S | S indicates that command IDs contained in the table of sequential commands are to be released

#### Example 4

The same global format ID is defined for several files. Release it for all files.

#### Control Block

Command Code | RC |
Command Option 1/2 | L | releases the formats of the global format ID contained in the Additions 5 field.
Additions 5 | C'TGLOB001' | B'11' in the two high-order (leftmost) bits of the first byte of this number identify all eight bytes as the global format ID.

#### Example 5

The same global format ID is defined for several files. Release it for the file 3 only.

#### Control Block

Command Code | RC |
File Number | 03 | binary number of the file for which the global format ID is to be released.
Command Option 1/2 | O | releases the formats of the global format ID contained in the Additions 5 field for the file specified in the file number field.
Additions 5 | C'TGLOB001' | B'11' in the two high-order (leftmost) bits of the first byte of this number identify all eight bytes as the global format ID.

## ACBX Interface Direct Call: RC Command

This section describes ACBX interface direct calls for the RC command. It covers the following topics:

- Control Block and Buffer Information

- Control Block Field Descriptions

### Control Block and Buffer Information

#### Control Block

Field | Position | Format | Before Adabas Call | After Adabas Call
--- | --- | --- | --- | ---
| 1-2 | --- | --- | ---
Version Indicator | 3-4 | binary | F | U
| 5-6 | --- | --- | ---
Command Code | 7-8 | alphanumeric | F | U
| 9-10 | --- | --- | ---
Response Code | 11-12 | binary | --- | A
Command ID | 13-16 | alphanumeric/ binary | F | U
Database ID | 17-20 | numeric | F | U
File Number | 21-24 | numeric | F | U
| 25-48 | --- | --- | ---
Command Option 1 | 49 | alphanumeric | F | U
Command Option 2 | 50 | alphanumeric | F | U
| 51-56 | --- | --- | ---
Additions 1 | 57-64 | alphanumeric/ binary | F | U
| 65-84 |  | --- | ---
Additions 5 | 85-92 | alphanumeric/ binary | F | U
| 93-114 | --- | --- | ---
Error Subcode | 115-116 | binary | --- | A
| 117-144 | --- | --- | ---
Command Time | 145-152 | binary | --- | A
User Area | 153-168 | not applicable | --- | U
--- | 169-193 | do not touch | --- | ---

#### ABDs and Buffers

None used.

where:

F | Supplied by user before Adabas call
A | Supplied by Adabas
U | Unchanged after Adabas call
-- | Not used

### Control Block Field Descriptions

We recommend that you set unused ACBX fields to binary zeros before the direct call is initiated.

> Version Indicator (ACBXVER)

>   F2

> Command Code (ACBXCMD)

>   RC

> Response Code (ACBXRSP)

>   Adabas returns the response code for the command in this field. Response code 0 (ADARSP000) indicates that the command was executed successfully. Non-zero response codes, which can also have accompanying subcodes returned in the Error Subcode (ACBXERRC) field, are described in the Adabas Messages and Codes Manual documentation.

> Command ID (ACBXCID)

>   The command ID to be released or to be used as a reference is specified in this field. A value of blanks or binary zeros releases all the command IDs currently assigned to the user.

> Database ID (ACBXDBID)

>   Use this field to specify the database ID. The Adabas call will be directed to this database.

>   This field is a four-byte binary field, but at this time only two-byte database IDs are supported. Therefore, the database ID should be specified in the low-order part (rightmost bytes) of the field, with leading binary zeros.

>   If this field is set to binary zeros, the Adabas API uses either the database ID from the ADARUN cards provided in DDCARD input data or the default database ID value provided in the LNKGBLS module linked with or loaded by the link routine.

> File Number (ACBXFNR)

>   If the Command Option 1 field is set to D, E, or O, use this field to specify the number of the file associated with the format or global format ID to be released.

>   This field is a four-byte binary field, but the file number should be specified in the low-order part (rightmost bytes) of the field, with leading binary zeros.

> Command Options 1 and 2: Type of Command IDs to Be Released (ACBXCOP1 and ACBXCOP2)

>   These fields are used to indicate that a command ID, format ID, or global format ID is to be released from the internal format buffer pool, the ISN list table (TBI), or the table of sequential commands (TBLES/TBQ). For information about the tables, see the section General Programming Considerations.

>   If both Command Option 1/2 fields are set to blanks or binary zeros, the command ID specified in the command ID field is released from all tables in which it is present.

>   If either Command Option field is set to one of the following values, the resources associated with the command ID, format ID, or global format ID are released as indicated:

>   Option | Releases . . .
>   --- | ---
>   C | all existing global formats
>   D | all formats for a given file number and descriptor name
>   E | all global formats for a given file number and descriptor name
>   F | the format associated with the specified command ID
>   G | all existing formats associated with command IDs greater than or equal to the specified command ID
>   I | the ISN list (TBI) associated with the specified command ID
>   L | the global format ID contained in the Additions 5 field.
>   O | the global format ID contained in the Additions 5 field for a given file number.
>   S | the sequential commands (TBLES/TBQ) associated with the specified command ID
>   X | all ISN lists (TBI) and sequential commands (TBLES/TBQ) associated with command IDs that are greater than or equal to the specified command ID. Internal formats are not released.

>   Options D and E are used when the format was created by an L3 or L6 command to ensure the return of correct data in an environment where Smith/Jones problems are possible. The underlying format identifier in these cases is 12 bytes: an 8-byte format ID, a 2-byte file number, and a 2-byte descriptor name.

> Additions 1: Descriptor Name (ACBXADD1)

>   If Command Option D or E is specified, the first two bytes of the Additions 1 field must contain the alphanumeric descriptor field name associated with the format or global format ID to be released. All remaining positions must be set to blanks.

>   If the format to be released was not created using the L3 or L6 command, this field is not used.

> Additions 5: Released Global Format ID (ACBXADD5)

>   In this field, specify a global format ID to be released.

> Error Subcode (ACBXERRC)

>   If the command returns a nonzero response code, this field contains a subcode defining the exact response code meaning. Response codes and their subcodes are defined in the Adabas Messages and Codes Manual documentation.

### On this page

- Function and Use
- ACB Interface Direct Call: RC Command
- ACBX Interface Direct Call: RC Command