INQUIRE CONTAINER

Retrieve the attributes of a BTS data-container.

INQUIRE CONTAINER

Read syntax diagramSkip visual syntax diagramINQUIRECONTAINER( data-value)ACTIVITYID( data-value)PROCESS( data-value)PROCESSTYPE( data-value)DATALENGTH( data-area)SET( data-area)

Conditions: ACTIVITYERR, CONTAINERERR, IOERR, NOTAUTH, PROCESSERR

Description

INQUIRE CONTAINER returns a pointer to the contents of a named BTS data-container, plus the length of the data.

To inquire upon a container associated with the current activity, omit the ACTIVITYID and PROCESS options.

To inquire upon a container associated with another activity, specify the ACTIVITYID option. (The activity identifier specified on the ACTIVITYID option may, for example, have been returned on a GETNEXT ACTIVITY command during a browse operation.)

To inquire upon a process container (including one associated with the current process), specify the PROCESS and PROCESSTYPE options.

Note:
  1. Inquiring on a container of the current activity returns details of the in-storage version, rather than the committed version on the repository. This means that it's possible to see:
    • Containers that are not yet on the repository
    • Container contents that differ from those on the repository.
  2. Inquiring on a container not owned by the current activity returns details of the committed version on the repository. However, the read of the repository record is “dirty”—the record is not locked. So, if the record is being updated by another task, it's possible for the returned data to be unreliable.

Options

ACTIVITYID(data-value)
specifies the identifier (1–52 characters) of the activity which the data-container is associated with.

If both this and the process options are omitted, the current activity is assumed.

CONTAINER(data-value)
specifies the name (1–16 characters) of the data-container being inquired upon.
DATALENGTH(data-area)
returns the fullword length of the data contained in the named data-container.
PROCESS(data-value)
specifies the name (1–36 characters) of the process which the data-container is associated with.

If both this and the ACTIVITYID option are omitted, the current activity is assumed.

PROCESSTYPE(data-value)
specifies the process-type (1–8 characters) of the process named in the PROCESS option.
SET(data-area)
returns a pointer to the contents of the data-container.

Conditions

109 ACTIVITYERR
RESP2 values:
2
The activity indicated by the ACTIVITYID option could not be found.
3
Because neither the ACTIVITYID nor the PROCESS options were specified, an inquiry on the current activity was implied—but there is no current activity associated with the request.
29
The repository file is unavailable.
30
An input/output error has occurred on the repository file.
110 CONTAINERERR
RESP2 values:
1
The container specified on the CONTAINER option could not be found.
17 IOERR
RESP2 values:
30
An input/output error has occurred on the repository file.
70 NOTAUTH
RESP2 values:
101
The user associated with the issuing task is not authorized to access this resource in the way requested.
108 PROCESSERR
RESP2 values:
2
The process-type specified on the PROCESSTYPE option could not be found.
4
The process specified on the PROCESS option could not be found.
13
The request timed out. It may be that another task using this process-record has been prevented from ending.
33
The process specified on the PROCESS option has not yet been committed.