FramingReader.ReadRecord Method
Returns the next record in the framed message in read-only mode.
Namespace: Microsoft.Web.Services3.Messaging.Framing
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)
Usage
'Usage
Dim returnValue As FramingRecord
Dim framingReader1 As FramingReader
returnValue = framingReader1.ReadRecord()
Syntax
'Declaration
Public Function ReadRecord() As FramingRecord
public FramingRecord ReadRecord();
public:
FramingRecord^ ReadRecord();
public FramingRecord ReadRecord();
public function ReadRecord() : FramingRecord;
Return Value
A read-only FramingRecord, or null if at the end of the framed message or if the record has TNF= None and is the last record in the message.
Exceptions
| Exception type | Condition |
|---|---|
| InvalidOperationException | The current record is closed. |
| FramingFormatException | The first record lacks the message begin flag or subsequent records have the flag. |
Remarks
If the FramingReader is closed, then an InvalidOperationException will be thrown. When the end of the message is reached, the ReadRecord method will return null . A call to ReadRecord is a blocking I/O call because the framed record header is read before the method returns.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Development Platforms
Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server
Target Platforms
See Also
Reference
FramingReader Class
FramingReader Members
Microsoft.Web.Services3.Messaging.Framing Namespace