CP_InStream.cpp File Reference

Namespaces
namespace	CPLAT_Begin_Namespace_CPLAT
Functions
void	ReadStringFromStream (CP_InStream &inStream, CP_String &outString)
CP_InStream &	operator>> (CP_InStream &inStream, char &inChar)
CP_InStream &	operator>> (CP_InStream &inStream, unsigned char &inUchar)
CP_InStream &	operator>> (CP_InStream &inStream, char *inChar)
CP_InStream &	operator>> (CP_InStream &inStream, unsigned char *inChar)
CP_InStream &	operator>> (CP_InStream &inStream, SInt16 &inSInt16)
CP_InStream &	operator>> (CP_InStream &inStream, UInt16 &inUInt16)
CP_InStream &	operator>> (CP_InStream &inStream, SInt32 &inSInt32)
CP_InStream &	operator>> (CP_InStream &inStream, UInt32 &inUInt32)
CP_InStream &	operator>> (CP_InStream &inStream, float &inFloat)
CP_InStream &	operator>> (CP_InStream &inStream, double &inDouble)
CP_InStream &	operator>> (CP_InStream &inStream, bool &inBool)
CP_InStream &	operator>> (CP_InStream &inStream, CP_String &inString)
CP_InStream &	operator>> (CP_InStream &inStream, CP_Point &inPoint)
CP_InStream &	operator>> (CP_InStream &inStream, CP_Size &inSize)
CP_InStream &	operator>> (CP_InStream &inStream, CP_Rect &inRect)
CP_InStream &	operator>> (CP_InStream &inStream, CP_RGBColor &inRGBColor)
CP_InStream &	operator>> (CP_InStream &inStream, CP_HandleBlock &inHandle)
CP_InStream &	operator>> (CP_InStream &inStream, CP_PtrBlock &inPtr)
CP_InStream &	operator>> (CP_InStream &inStream, CP_FileSystemSpec &inFileSpec)

---

Function Documentation

void ReadStringFromStream (  CP_InStream &  inStream, CP_String &  outString )

CP_InStream& operator>> (  CP_InStream &  inStream, char &  inChar )

>> operator for a char to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A char to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, unsigned char &  inUchar )

>> operator for a unsigned char to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A unsigned char to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, char *  inChar )

>> operator for a char * to read in some data and assign to the passed in data field. This data is formatted as a length (UInt32) followed by the actual character data. Parameters: inStream  The CP_InStream object used to read the data. inChar  A buffer to hold the read in data. It needs to be big enough to hold all of the data, and will be NULL terminated. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, unsigned char *  inChar )

>> operator for an unsigned char * to read in some data and assign to the passed in data field. This data is formatted as a length (UInt32) followed by the actual character data. Parameters: inStream  The CP_InStream object used to read the data. inChar  A buffer to hold the read in data. It needs to be big enough to hold all of the data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, SInt16 &  inSInt16 )

>> operator for a SInt16 to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A SInt16 to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, UInt16 &  inUInt16 )

>> operator for a UInt16 to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A UInt16 to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, SInt32 &  inSInt32 )

>> operator for a SInt32 to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A SInt32 to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, UInt32 &  inUInt32 )

>> operator for a UInt32 to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A UInt32 to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, float &  inFloat )

>> operator for a float to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A float to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, double &  inDouble )

>> operator for a double to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A double to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, bool &  inBool )

>> operator for a bool to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inChar  A bool to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_String &  inString )

>> operator for a CP_String to read in some data and assign to the passed in data field. The data is stored as a length (SInt32) followed by the character data. Parameters: inStream  The CP_InStream object used to read the data. inChar  A char buffer to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_Point &  inPoint )

>> operator for a CP_Point to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inPoint  A CP_Point object to hold the read in data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_Size &  inSize )

>> operator for a CP_Size to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inSize  A CP_Size object to hold the results. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_Rect &  inRect )

>> operator for a CP_Rect to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inRect  A CP_Rect object to hold the results. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_RGBColor &  inRGBColor )

>> operator for a CP_RGBColor to read in some data and assign to the passed in data field. Parameters: inStream  The CP_InStream object used to read the data. inSize  A CP_RGBColor object to hold the results. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_HandleBlock &  inHandle )

>> operator for a CP_HandleBlock to read in some data and assign to the passed in data field. The CP_HandleBlock length is set to the length of the data and the block contains the actual data. Parameters: inStream  The CP_InStream object used to read the data. inHandle  A CP_HandleBlock object to hold the data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_PtrBlock &  inPtr )

>> operator for a CP_PtrBlock to read in some data and assign to the passed in data field. The CP_PtrBlock length is set to the length of the data and the block contains the actual data. Parameters: inStream  The CP_InStream object used to read the data. inPtr  A CP_PtrBlock object to hold the data. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

CP_InStream& operator>> (  CP_InStream &  inStream, CP_FileSystemSpec &  inFileSpec )

>> operator for a CP_FileSystemSpec to read in some data and assign to the passed in data field. The data is stored as a full path string. Parameters: inStream  The CP_InStream object used to read the data. inSize  A CP_FileSystemSpec object to hold the results. Exceptions: none  Returns: CP_InStream& Returns a copy of this object.

---