Share via


GraphicsStream.Read(Boolean) Method (Microsoft.DirectX)

Reads from the current stream and advances the position within it by the number of bytes read.

Definition

Visual Basic Public Function Read( _
    ByVal unicode As Boolean _
) As String
C# public string Read(
    bool unicode
);
C++ public:
StringLeave SiteRead(
    bool unicode
);
JScript public function Read(
    unicode : boolean
) : String;

Parameters

unicode System.Boolean
Set to true if the graphics stream is Unicode. Set to false if the graphics stream is ASCII.

Return Value

System.String
A StringLeave Site that contains the data to read from the stream buffer.

Remarks

Exceptions

NotSupportedExceptionLeave Site

Unable to read from the stream buffer, or there is no data to read.

ArgumentExceptionLeave Site

One of the parameters is invalid, the stream buffer is not large enough to hold the requested data, or ranks is greater than three.