DimeWriter.NewRecord Method (String, String, TypeFormat)

Article
09/15/2006
2 minutes to read

Creates and returns a new DIME record with a specified ID and of a specified payload type, and typeFormat.

Namespace: Microsoft.Web.Services2.Dime
Assembly: Microsoft.Web.Services2 (in microsoft.web.services2.dll)

Usage

'Usage
Dim id As String
Dim type As String
Dim typeFormat As TypeFormat
Dim returnValue As DimeRecord
Dim dimeWriter1 As DimeWriter
returnValue = dimeWriter1.NewRecord(id, type, typeFormat)

Syntax

'Declaration
Overloads Public Function NewRecord( _
    ByVal id As String, _
    ByVal type As String, _
    ByVal typeFormat As TypeFormat _
) As DimeRecord

public DimeRecord NewRecord(
    string id, 
    string type, 
    TypeFormat typeFormat
);

public: DimeRecord^ NewRecord(
    String^ id, 
    String^ type, 
    TypeFormat^ typeFormat
);

public DimeRecord NewRecord(
    System.String id, 
    System.String type, 
    TypeFormat typeFormat
);

public function NewRecord(
     id : String, 
     type : String, 
     typeFormat : TypeFormat
) : DimeRecord;

Parameters

id
A System.Uri containing the absolute or relative URI identifying the record.

type
The payload type.

typeFormat
One of the TypeFormat values that specifies the format of the payload type.

Return Value

The next DimeRecord to write in the DIME message with the specified values.

Exceptions

Exception type	Condition
System.ArgumentNullException	The id or type is null .
System.InvalidOperationException	Either the DIME message has been closed. -or- A last record has already been written for this DIME message.

System.ArgumentNullException

The id or type is null .

System.InvalidOperationException

Either the DIME message has been closed.

-or-

A last record has already been written for this DIME message.

Remarks

When the NewRecord method is used to create the last record containing a positive payload length, Close will then be called and an additional empty last record will be appended to the DIME message. This occurs, for example, when the size of the message is not known and its payload is being chunked.

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 Longhorn, and Windows 2000

Target Platforms

Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server, Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, Pocket PC, Windows CE, Smart Phone