Titus Information Systems CSDisFile Class

Titus Information Systems, Inc.

Standard Library
CSDisFile Class

This class is inherited from CDocument and provides additional public member functions and variables to perform file I/O to a Standard Display text file. This class is normally instantiated by the CSDisView class and is not normally inherited, overridden, or in any way used in a stand-alone fashion by C++ functions. The public member functions and variables are as follows:

CSDisFile::CSDisFile(): This is the constructor. It initializes the data members.
void CSDisFile::Open(CString FileName): This member function opens for input the specified Standard Display text file. Specify the complete path name in FileName. This function also sets the data members and allocates memory according to the parameters in the text file. If the file is successfully accessed and all the data members are successfully loaded, CSDisCreate::ReturnCode will be zero. Otherwise CSDisCreate::ReturnCode indicates the error that occurred.
void CSDisFile::Close(): This member function closes the Standard Display text file and deallocates memory. If no file is open, CSDisCreate::ReturnCode will be -1. Otherwise, CSDisCreate::ReturnCode will be zero.
void CSDisFile::NewPage(int Page): This member function loads the specified page into memory. If the page is successfully accessed, CSDisCreate::ReturnCode will be zero. Otherwise CSDisCreate::ReturnCode indicates the error that occurred.
void CSDisFile::Scroll(int Lines): This member function scrolls the memory pointers by the indicated number lines, which may be positive to move forward or negative to move backward. If the page can be successfully scrolled as requested, CSDisCreate::ReturnCode will be zero. Otherwise CSDisCreate::ReturnCode indicates the error that occurred.
int CSDisFile::Remain(int Page, int Screen): This member function returns the remaining number of lines on the specified page. The number of lines on the Screen is required for this calculation. If the calculation is performed successfully, CSDisCreate::ReturnCode will be zero. Otherwise CSDisCreate::ReturnCode indicates the error that occurred.
packet CSDisFile::Display(): This member function returns the next data packet on the line in the page. If the packet is available, CSDisCreate::ReturnCode will be zero. Otherwise CSDisCreate::ReturnCode indicates the error that occurred.
int CSDisFile::FileByte int CSDisFile::FileLine int CSDisFile::FilePage int CSDisFile::MaxPacket int CSDisFile::MaxLine int CSDisFile::MaxByte int CSDisFile::PageNumber int CSDisFile::PagePacket int CSDisFile::PageLine int CSDisFile::PageByte int CSDisFile::LineByte int CSDisFile::PageLPI int CSDisFile::PageTop int CSDisFile::PageLength int CSDisFile::PageCPI int CSDisFile::PageLeft int CSDisFile::PageWidth int CSDisFile::HeaderLine int CSDisFile::HeaderPacket int CSDisFile::TopLine int CSDisFile::TopPacket int CSDisFile::NextPacket: These data members are pointers to the display page currently loaded into memory. They are normally neither accessed nor adjusted by other functions or classes.
short CSDisFile::ReturnCode: This data member is set by the member functions to indicate success or failure. It should be examined after every function call to insure the Standard Display text file has been properly accessed.
BOOL CSDisFile::FileStatus: This data member shows whether or not the Standard Display text file is open.