RCCUCO

RCCUCO cancels check out for the list of files identified by the fully qualified file names.

Syntax

RCCUCO(platform,CCtype,viewType,host,port,view,listOfFullyQualifiedFileName,activity,TSCdirectory,distributedUserName,client_codepage,server_codepage,client_rt_codepage,timeout,cq_id,cq_passwd,cq_dbset,verbose_option)

Arguments

You can use the following arguments when you run the RCCUCO function:

platform
The name of the platform that contains the DevOps Code ClearCase® VOB. Allowable values: WINDOWS or UNIX®.
CCtype
The type of DevOps Code ClearCase environment. Allowable values: UCM or NONUCM.
viewType
The type of DevOps Code ClearCase view. Allowable values: SNAPSHOT or DYNAMIC.
host
The TCP/IP address or DNS name of the machine that contains the DevOps Code ClearCase VOB. This address must be a valid TCP/IP address or DNS name.
port
The TCP/IP port number used to contact the host specified by the host argument. Allowable values: 0-65535.
view
The DevOps Code ClearCase view used to access the fully qualified file name. This argument is required only when the platform is UNIX and the view type is DYNAMIC. Otherwise, the argument is null.
listOfFullyQualifiedFileName
The list of files to be checked out. Fully qualified file name entries in the list are delimited with X'00'.
activity
The name of the DevOps Code ClearCase activity. This argument is required for UCM; otherwise, it is null.
TSCdirectory
The name of the directory on the host machine from which the server component of TSO Client was started.
distributedUserName
The user ID on the distributed system on which you are running DevOps Code ClearCase and the server component of TSO Client.
client_codepage
The code page for the input, output, and build script files on the client. Code page conversion occurs only on text files. This argument is optional.
server_codepage
The code page used on the server. This argument is optional.
client_rt_codepage
The code page for the distributed system's locale. This option defaults to the same value as is specified with the client codepage client_codepage argument. This argument is optional.
timeout
The number of minutes that the server waits for an invoked build script to return before stopping the build event. This argument is optional.
cq_id
A ClearQuest® user ID. This argument is optional.
cq_passwd
The password for the ClearQuest user ID. This argument is optional.
cq_dbset
The name of the schema repository to be used by ClearQuest. This argument is optional.
verbose_option
The message verbosity. The value for this argument can be -V, -V -V, or -V -V -V. This argument is optional.

Result

The following table lists the return and reason codes that result from running the RCCUCO function; it also provides a description of the meaning of the codes.

Table 1. Result of running the RCCUCO function
Return code Reason code Description
0 600 Processing successful.
8 611 Required argument missing.
612 Invalid argument value.
614 Nonzero return code from EXECIO.
616 Improper number of arguments.
617 Invalid file type.
618 Invalid multiple file types.
619 Null file type in name.
621 Invalid multiple directories.
622 Invalid file name in list.
697 Invalid combination of platform, CCtype, and viewType.
12 698 Internal error.
699 Internal error.

Example

From the DevOps Code ClearCase VOB testvob, cancel a check out for the COBOL programs pg1 and pg2.

The VOB resides on a UNIX machine with a domain name of TEST.onsome.domain.com.

The server component of TSO Client is installed in var/tmp/samples/ and is running with auth mode 0, using port 4000.

The NONUCM, DYNAMIC view is nonucmview.

The following REXX™ commands could be used to invoke the RCCUCO API function:

pltf = ‘UNIX'
cctype = ‘NONUCM'
vtype = ‘DYNAMIC'
host = ‘TEST.onsome.domain.com''
port = ‘4000'
view = ‘nonucmview'
files = ‘/var/tmp/testvob/dir1/pg1.cbl'||'00'x || '/var/tmp/testvob/dir1/pg2.cbl'
dir = ‘/var/tmp/samples/userID'
disuser = ‘userone'
Parse Value RCCUCO(pltf,cctype,vtype,host,port,view,files,,dir,disuser) 
With rccret rccrsn rccmsg

Output

For a list of the output data sets corresponding to the RCCLOG1, RCCOUT, and RCCERR file names, see RCCUALOC.

For a description of the log entries in RCCLOG1, see RCCULOG.

For an example listing of the log, see Example of a log entry.

RCCOUT contains verification that checkout of the specified files was cancelled.

RCCOUT example

After a successful completion of the API call in the previous example, RCCOUT contains the following message:

Checkout cancelled for "testvob\dir1\pg1.cbl".
Checkout cancelled for "testvob\dir1\pg2.cbl".