enum KcsIOPosition {KCS_OFS, KCS_BOO,
 	KCS_CUR};

Used for calls to setCursorPos().

KCS_OFS is relative to beginning of I/O object+baseoffset. KCS_BOO is relative to beginning of the I/O object. KCS_CUR is relative to present I/O cursor.

KcsStatus
aSysError(const char *callersName,
 	const char *sysName, KcsStatus stat,
 	const int sysErrCode);

A protected member that returns a KcsStatus object that contains the OS error in the causingError data member. Use callersName for debugging; it is recommended that you change to a non-NULL value.

virtual
KcsStatus absRead(const long index,
 	const long bytesWanted,
 	void *buffer,
 	const char *callersName = NULL);

Absolute read an I/O object already opened or allocated. Supply a count of number of bytes to read and a buffer.  

virtual
KcsStatus absWrite(const long index,
 	const long numBytes2Write,
 	const void *buffer,
 	const char *callersName = NULL);

Absolute write to some number of bytes in numBytes2Write from the buffer to the data store at the current position of the cursor

virtual
KcsStatus copyData(KcsIO *anotherIO);

Copies all data in I/O object to anotherIO object.

static KcsIO * createIO(KcsStatus *aStatus,
 	const KcsProfileDesc *aDesc);

Static method that creates an I/O object, by calling either a KcsIO derivative constructor within the KCMS library or a run-time loadable constructor.

virtual
KcsStatus getEOF(long *theEOF) = 0;

Returns the end-of-file (EOF) position. 

virtual 
long getOffset();

Returns the permanent offset into the I/O object. 

virtual
KcsIOType getType() = 0;

Returns the type of I/O object. 

virtual 
int isEqual(KcsIO *anotherIO) = 0;

Determines if this I/O object and another I/O object are working on the same data stores. The base offsets must also be the same for them to return true. 

KcsIO(KcsStatus *status,
 	const unsigned long absBaseOffset = 0);

Constructor that initializes the baseOffset data member with the values passed in.

virtual ~KcsIO();

Destructor.

virtual 
KcsStatus relRead(const long bytesWanted,
 	void *buffer,
 	const char *callersName = NULL) = 0;

Reads bytesWanted from the I/O object from the current position of the cursor. Positions the cursor after the last byte read.

virtual
KcsStatus relWrite(const long numBytes2Write,
 	const void *buffer,
 	const char *callersName = NULL) = 0;

Relative write of the number of bytes in numBytes2Write from the buffer to the data store at the current position of the cursor. Positions the cursor after the last byte written.

virtual
KcsStatus replaceData(const unsigned long offset,
 	const unsigned long oldSize,
 	const void *buffer,
 	const unsigned long newSize,
 	const char *callersName = NULL);

Replaces bytes of different lengths in an I/O object. Specifies where to start writing and size of old and new data. If the old data is longer than the new data, the I/O object is compressed. If the new data is longer than the old data, everything after the old data is moved to the end of the I/O object. If an error occurs, the cursor is where it was before the error occurred.  

virtual 
KcsStatus setCursorPos(long position,
 	const KcsIOPosition mode= KCS_OFS,
 	const char *callersName = NULL) = 0;

Sets the I/O object cursor to a caller-supplied position.

Positions the I/O object cursor to a specific spot in the object. Mode is defined by the enum KcsFilePosition.

virtual
KcsStatus setEOF(long theEOF) = 0;

Sets the EOF to a caller-supplied position. If the new EOF is greater than the old EOF, the storage for the new space is undefined. 

virtual
void setOffset(long theOffset);

Sets the base offset to a specified position.

getEOF()

X 

getType()

X 

isEqual()

X 

KcsIO()

X 

~KcsIO()

X 

relRead()

X 

relWrite()

X 

setCursorPos()

X 

setEOF()

X 

setOffset()

X 

//Read 4 bytes from KcsIO starting at byte 8.
 long getTheSecondLong(KcsStatus *aStat, KcsIO *aIO)
 {
 	long badNumber = -1;
 	long sSecondLong;

 	if (aIO == NULL)
 		return(badNumber);
 	if ((*aStat = aIO->absRead(8, 4, &sSecondLong)) == KCS_SUCCESS)
 		return(sSecondLong);
 	else
 		return(badNumber);
 }

enum KcsMemoryKind {
 	KCS_APPLICATION_HEAP,
 	KCS_SYSTEM_HEAP };

enum used in setCursorPos(). The object is in the application or system heap.

long allocMe;

Determines whether memory block is allocated. 

char* curPtr();

Returns the current address of the memory block + position. 

long numElements;

Number of elements if memory block is an array.

long pos;

Current position in memory block. 

long realEOF;

Number of bytes actually written to memory file. 

long size;

Number of bytes allocated to contain memory file. 

char *startPtr;

Start of char-pointer-based memory block. 

KcsStatus
get(char* buf, long nbytes);

Gets nbytes of data starting at the current cursor position. Post-increments the cursor position by nbytes.

long getNumElements() {return numElements;}

Returns the number of elements in the KcsMemoryBlock object as a long.

long getSize();

Returns the size of the KcsMemoryBlock object.

KcsMemoryBlock(KcsStatus *status, char *start,
 	long size, long numElements = 1,
 	const unsigned long absBaseOffset = 0);

Constructor. Specifies a character pointer in start, block size in size, and number of elements in numElements.

KcsMemoryBlock(KcsStatus *status, long size,
 	long numElements = 1,
 	const unsigned long absBaseOffset = 0,
 	const KcsMemoryKind kind =
 		KCS_APPLICATION_HEAP);

Constructor. Allocates and deallocates the memory. 

virtual ~KcsMemoryBlock();

Destructor. 

long position() {return pos;}

Returns the current cursor position. 

void position(long posit) {pos=posit;}

Sets the current cursor position. 

KcsStatus
put(char* buf, long nbytes);

Puts nbytes of data into the KcsMemoryBlock object at the current cursor position. Post-increments the cursor position by nbytes.

KcsStatus resizeIt()
 {
 	unsigned long sNewSize = 10;
 	KcsStatus sStatus;
 	KcsMemoryBlock *memBlock;
 	char * buffer = {`a','b','c','d'};

 	// create a new KcsMemoryBlock object
 	memBlock = new KcsMemoryBlock(&sStatus,4);
 	if (sStatus != KCS_SUCCESS)
 			return (sStatus);
 	// put the four bytes above into the new KcsMemoryBlock
 	sStatus = memBlock->put(buffer,4);
 	if (sStatus != KCS_SUCCESS)
 			return (sStatus);
 	// resize the KcsMemoryBlock from 4 to 10	
 	sStatus = memBlock->reSize(sNewSize);
 	//Finished with the data
 	delete memBlock;
 	return (sStatus);
 }

virtual long getFref();

Gets the file description being used. 

KcsFile(KcsStatus *status);

Constructor. Creates a file object without a file and offset. You must use setFref() to establish a link to a file before using any other methods.

KcsFile(KcsStatus *status,
 	const KcsFileId anFref,
 	const unsigned long absBaseOffset = 0);

Constructor. Creates a file object with an open file and offset. 

virtual ~KcsFile();

Destructor. 

virtual void setFref(long theFref);

Sets the file to use and the offset. 

KcsStatus readIt()
 {
 	KcsStatus sStatus;
 	KcsFileId sFileRef;
 	long index = 32;
 	long number;

 	// open the file, put the fileRef into sFileRef
 	sFileRef = open ("Profile", O_RDWR);
 	if (sFileRef == -1)
 			return (KCS_IO_ERROR);
 	// create a file object
 	file = new KcsFile(&sStatus, sFileRef, 0);
 	if (sStatus != KCS_SUCCESS)
 			return(sStatus);

 	// using the file object, read from the file into a buffer.
 	sStatus = file->absRead(index, sizeof(long), &number);
 	delete file;
 	close(sFileRef);

 	return (sStatus);
 }

KcsStatus writeIt()
 {
 	KcsStatus sStatus;
 	KcsFileId sFileRef;
 	long nbytes;
 	char *buffer;

 	// open the file, get a fileRef
 	sFileRef = open ("Profile", O_RDWR);
 	if (sFileRef == -1)
 			return (KCS_IO_ERROR);

 	// create a file object
 	file = new KcsFile(&sStatus, sFileRef);
 	if (sStatus != KCS_SUCCESS)
 			return(sStatus);

 	// Allocate memory for the buffer, fill it with data.
 	// Set nbytes to the length of the buffer.
 	if ((buffer = (char*) malloc(nbytes)) == NULL)
 			return (KCS_IO_ERROR);
 	delete file;
 	close(sFileRef);

 	// using the file object, write the buffer to the file.
 	sStatus = file->relWrite(nbytes, buffer);

 	// Free the buffer's memory.
 	free (buffer);
 	delete file;
 	close(sFileRef);

 	return (sStatus);
 }

virtual KcsIO* getIO();

Returns the I/O pointer.  

KcsSolarisFile(KcsStatus *status,
 	const char *filename,
 	const char *hostname,
 	const int oflag,
 	const mode_t mode);

Constructs a new I/O object pointer to a file (full path and suffix not needed) either a remote or local machine. The file is opened with the specified permissions. See the open(2) man page for information on oflag and mode. 

virtual ~KcsSolarisFile();

Destructor. 

virtual
	KcsIO* getIO();

Returns the I/O pointer. 

KcsXWindow(KcsStatus *status,
 	const Display *dpy, const int screen,
 	const Visual *visual, const long caller)

Constructs a new IO object pointer to a profile connected to the machine and display. The specific X Window System profile name is constructed. The location is either a known local directory or a path specified by the KCMS_XTERMINAL_PROFILES environment variable.

virtual ~KcsXWindow()

Destructor.