The opt parameter
Many methods have the same parameter, opt, which is described
under the abendCode method inabendCode.
unsigned long access(Icc::GetOpt opt =Icc::object)
- opt
- An enumeration, defined in Icc structure, that indicates whether you can use a value previously retrieved
from CICS® (object), or whether the object should retrieve a fresh value from
CICS.
Returns a composite number indicating the access properties of
the file. See also isReadable, isBrowsable, isAddable, isDeletable, and isUpdatable methods.
IccValue::CVDA accessMethod(Icc::GetOpt opt = Icc::object)
Returns an enumeration, defined in IccValue, that represents the access method for this file. Possible values are:
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
Signals the start of a mass insertion of data into the file.
void deleteLockedRecord(unsigned long updateToken = 0)
- updateToken
- A token that indicates which previously read record is to
be deleted. This is the token that is returned from readRecord method when in update mode.
Deletes a record that has been previously locked by readRecord method in update mode. (See also readRecord method.)
Conditions
DISABLED, DUPKEY, FILENOTFOUND, ILLOGIC, INVREQ, IOERR, ISCINVREQ,
NOTAUTH, NOTFIND, NOTOPEN, SYSIDERR, LOADING
unsigned short deleteRecord()
Deletes one or more records, as specified by the associated IccRecordIndex object, and returns the number
of deleted records.
Conditions
DISABLED, DUPKEY, FILENOTFOUND, ILLOGIC, INVREQ, IOERR, ISCINVREQ,
NOTAUTH, NOTFIND, NOTOPEN, SYSIDERR, LOADING
IccValue::CVDA enableStatus(Icc::GetOpt opt = Icc::object)
Returns an enumeration, defined in IccValue, that indicates whether the file is enabled to be used by programs.
Possible values are:
- DISABLED
- DISABLING
- ENABLED
- UNENABLED
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
Marks the end of a mass insertion operation. See beginInsert.
Icc::Bool isAddable(Icc::GetOpt opt = Icc::object)
Indicates whether more records can be added to the file.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
Icc::Bool isBrowsable(Icc::GetOpt opt = Icc::object)
Indicates whether the file can be browsed.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
Icc::Bool isDeletable(Icc::GetOpt opt = Icc::object)
Indicates whether the records in the file can be deleted.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
Icc::Bool isEmptyOnOpen(Icc::GetOpt opt = Icc::object)
Returns a Boolean that indicates whether the EMPTYREQ option
is specified. EMPTYREQ causes the object associated with this file to be set
to empty when opened, if it is a VSAM data set defined as reusable.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
Icc::Bool isReadable(Icc::GetOpt opt = Icc::object)
Indicates whether the file records can be read.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
Icc::Bool isRecoverable(Icc::GetOpt opt = Icc::object)
- opt
- See access method.
Conditions:
END,
FILENOTFOUND, ILLOGIC, NOTAUTH
Icc::Bool isUpdatable(Icc::GetOpt opt = Icc::object)
Indicates whether the file can be updated.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
unsigned long keyLength(Icc::GetOpt opt = Icc::object)
Returns the length of the search key.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
long keyPosition(Icc::GetOpt opt = Icc::object)
Returns the position of the key field in each record relative
to the beginning of the record. If there is no key, zero is returned.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
IccValue::CVDA openStatus(Icc::GetOpt opt = Icc::object)
Returns a CVDA that indicates the open status of the file. Possible
values are:
- CLOSED
- The file is closed.
- CLOSING
- The file is in the process of being closed. Closing a file
may require dynamic deallocation of data sets and deletion of shared resources,
so the process may last a significant length of time.
- CLOSEREQUEST
- The file is open and one or more application tasks are using
it. A request has been received to close it.
- OPEN
- The file is open.
- OPENING
- The file is in the process of being opened.
Conditions:
END,
FILENOTFOUND, ILLOGIC, NOTAUTH
const IccBuf& readRecord (ReadMode mode = normal,
unsigned long* updateToken = 0)
- mode
- An enumeration, defined in this class, that indicates in which
mode the record is to be read.
- updateToken
- A pointer to an unsigned long token that will be updated by the method when mode
is update and you wish to make multiple read updates. The token uniquely identifies
the update request and is passed to the deleteLockedRecord, rewriteRecord, or unlockRecord methods
Reads a record and returns a reference to an IccBuf object that contains the data from the record.
Conditions
DISABLED, DUPKEY, FILENOTFOUND, ILLOGIC, INVREQ, IOERR, ISCINVREQ,
LENGERR, NOTAUTH, NOTFND, NOTOPEN, SYSIDERR, LOADING
IccValue::CVDA recordFormat(Icc::GetOpt opt = Icc::object)
Returns a CVDA that indicates the format of the data. Possible
values are:
- FIXED
- The records are of fixed length.
- UNDEFINED (BDAM data sets only)
- The format of records on the file is undefined.
- VARIABLE
- The records are of variable length. If the file is associated
with a data table, the record format is always variable length, even if the
source data set contains fixed-length records.
Conditions:
END,
FILENOTFOUND, ILLOGIC, NOTAUTH
IccRecordIndex* recordIndex() const
Returns a pointer to an IccRecordIndex object that indicates which records are to be accessed when using methods
such as readRecord, writeRecord, and deleteRecord.
unsigned long recordLength(Icc::GetOpt opt = Icc::object)
Returns the length of the current record.
Conditions
END, FILENOTFOUND, ILLOGIC, NOTAUTH
void registerRecordIndex(IccRecordIndex* index)
- index
- A pointer to an IccKey, IccRBA, or IccRRN
object that will be used by methods such as readRecord, writeRecord, etc..
void rewriteRecord (const IccBuf& buffer,
unsigned long updateToken = 0)
- buffer
- A reference to the IccBuf
object that holds the new record data to be written to the file.
- updateToken
- The token that identifies which previously read record is
to be rewritten. See readRecord.
Updates a record with the contents of buffer.
Conditions
DISABLED, FILENOTFOUND, ILLOGIC, INVREQ, IOERR, ISCINVREQ, NOTAUTH,
NOTFND, NOTOPEN, SYSIDERR, LOADING
void setAccess(unsigned long access)
- access
- A positive integer value created by ORing (or adding) one
or more of the values of the Access enumeration, defined in this class.
Sets the permitted access to the file. For example:
file.setAccess(IccFile::readable + IccFile::notUpdatable);
Conditions
FILENOTFOUND, INVREQ, IOERR, NOTAUTH
void setEmptyOnOpen(Icc::Bool trueFalse)
Specifies whether or not to make the file empty when it is next
opened.
Conditions
FILENOTFOUND, INVREQ, IOERR, NOTAUTH
void setStatus(Status status)
- status
- An enumeration, defined in this class, that indicates the
required status of the file after this method is called.
Sets the status of the file.
Conditions
FILENOTFOUND, INVREQ, IOERR, NOTAUTH
IccValue::CVDA type(Icc::GetOpt opt = Icc::object)
Returns a CVDA that identifies the type of data set that corresponds
to this file. Possible values are:
- ESDS
- The data set is an entry-sequenced data set.
- KEYED
- The data set is addressed by physical keys.
- KSDS
- The data set is a key-sequenced data-set.
- NOTKEYED
- The data set is not addressed by physical keys.
- RRDS
- The data set is a relative record data set.
- VRRDS
- The data set is a variable relative record data set.
Conditions:
END, FILENOTFOUND,
ILLOGIC, NOTAUTH
void unlockRecord(unsigned long updateToken = 0)
- updateToken
- A token that indicates which previous readRecord update request is to be unlocked.
Unlock a record, previously locked by reading it in update mode.
See readRecord.
Conditions
DISABLED, FILENOTFOUND, ILLOGIC, IOERR, ISCINVREQ, NOTAUTH, NOTOPEN,
SYSIDERR, INVREQ
void writeRecord(const IccBuf& buffer)
- buffer
- A reference to the IccBuf
object that holds the data that is to be written into the record.
Write either a single record or a sequence of records, if used
with the beginInsert and endInsert methods.
Conditions
DISABLED, DUPREC, FILENOTFOUND, ILLOGIC, INVREEQ, IOERR, ISCINVREQ,
LENGERR, NOSPACE, NOTAUTH, NOTOPEN, SYSIDERR, LOADING, SUPPRESSED
[[ Contents Previous Page | Next Page Index ]]