---

ScreenPipe Class Reference

A server for reading screen buffers from VCC. More...

#include <ScreenPipe.h>

Inherits PServer.

List of all members.

Public Methods
DWORD	readToDIB (DIBitmap &)
	ScreenPipe (const TString &)
Private Types
typedef ScreenPipe::screenInfo	screenInfo
	The structure of the header for each screen buffer. More...
Private Methods
DWORD	readError ()

---

Detailed Description

This object is responsible for reading screen buffer data from the pipe and setting a DIBitmap.

Definition at line 26 of file ScreenPipe.h.

---

Member Typedef Documentation

typedef struct ScreenPipe::screenInfo ScreenPipe::screenInfo [private]

This is the first information on the pipe for each screen buffer. The size of the message is calculated from this information

---

Constructor & Destructor Documentation

ScreenPipe::ScreenPipe (  const TString &    name )

Parameters: name  : A TString used to generate unique names for the various kernel objects Definition at line 25 of file ScreenPipe.cpp. References BUFFER_SIZE. :PServer(TString( TEXT("Screen") ) + name, false, BUFFER_SIZE) {}

---

Member Function Documentation

DWORD ScreenPipe::readError (    )  [inline, private]

Error function for readToDIB() Definition at line 96 of file ScreenPipe.cpp. References PServer::disconnect(), SP_NOT_CONNECTED, and SP_UNKNOWN_ERROR. Referenced by readToDIB(). { switch(GetLastError()) { case ERROR_SECTOR_NOT_FOUND: disconnect(); return SP_NOT_CONNECTED; case ERROR_SUCCESS: // EOF? case ERROR_READ_FAULT: default: return SP_UNKNOWN_ERROR; } }

DWORD ScreenPipe::readToDIB (  DIBitmap &    destination )

A blocking function which reads data from the screen pipe and sets the given DIBitmap accordingly. Parameters: destination  : The DIBitmap which is set Definition at line 40 of file ScreenPipe.cpp. References ScreenPipe::screenInfo::bitCount, ScreenPipe::screenInfo::clrUsed, DIBitmap::createCompatible(), DIBitmap::getPBITMAPINFOHEADER(), DIBitmap::getPBytes(), DIBitmap::getPPalette(), ScreenPipe::screenInfo::hdrSize, ScreenPipe::screenInfo::height, Pipe::hPipe, readError(), SP_ERROR_CREATING_BITMAP, SP_INVALID_DATA, SP_SUCCESS, and ScreenPipe::screenInfo::width. Referenced by UpdateHandler::update(). { DWORD numBytesRead; bool isOk; screenInfo header; isOk = ReadFile( hPipe, // Read from &header, // data buffer sizeof(screenInfo), // number of bytes to read &numBytesRead, // number of bytes read NULL); // not overlapped if( !isOk || (numBytesRead != sizeof(screenInfo)) ) return readError(); if( header.hdrSize != sizeof(screenInfo) ){ return SP_INVALID_DATA; } if( !(destination.getPBITMAPINFOHEADER()->biBitCount == header.bitCount && destination.getPBITMAPINFOHEADER()->biHeight == header.height && destination.getPBITMAPINFOHEADER()->biWidth == header.width) ){ if( !destination.createCompatible(header.width, header.height, header.bitCount)) return SP_ERROR_CREATING_BITMAP; } LPRGBQUAD palette = destination.getPPalette(); RGBTRIPLE entry; for(int i=0; i < header.clrUsed; i++, palette++){ isOk = ReadFile(hPipe, &entry, sizeof(RGBTRIPLE), &numBytesRead, NULL); if( !isOk || (numBytesRead != sizeof(RGBTRIPLE)) ) return readError(); palette->rgbBlue = entry.rgbtBlue; palette->rgbGreen = entry.rgbtGreen; palette->rgbRed = entry.rgbtRed; palette->rgbReserved = 0; } // See DIBitmap documentation for explanation of this formula const DWORD size = (((( header.width * header.bitCount ) + 31) & ~31) >> 3) * header.height; isOk = ReadFile(hPipe, destination.getPBytes(), size, &numBytesRead, NULL); if( !isOk || (numBytesRead != size ) ) return readError(); return SP_SUCCESS; }

---

The documentation for this class was generated from the following files:

• ScreenPipe.h
• ScreenPipe.cpp

---