SendPacketsElement Constructor (String, Int32, Int32, Boolean)

 

Initializes a new instance of the SendPacketsElement class using the specified filename path, buffer offset, and count with an option to combine this element with the next element in a single send request from the sockets layer to the transport.

Namespace:   System.Net.Sockets
Assembly:  System (in System.dll)

public SendPacketsElement(
	string filepath,
	int offset,
	int count,
	bool endOfPacket
)

Parameters

filepath
Type: System.String

The filename of the file to be transmitted using the Socket.SendPacketsAsync method.

offset
Type: System.Int32

The offset, in bytes, from the beginning of the file to the location in the file to start sending the file specified in the filepath parameter.

count
Type: System.Int32

The number of bytes to send starting from the offset parameter. If count is zero, the entire file is sent.

endOfPacket
Type: System.Boolean

A Boolean value that specifies that this element should not be combined with the next element in a single send request from the sockets layer to the transport. This flag is used for granular control of the content of each message on a datagram or message-oriented socket.

Exception Condition
ArgumentNullException

The filepath parameter cannot be null

ArgumentOutOfRangeException

The offset and count parameters must be greater than or equal to zero.

The offset and count must be less than the size of the file indicated by the filepath parameter.

The SendPacketsElement(String, Int32, Int32, Boolean) constructor initializes a new instance of the SendPacketsElement class with a filename of a file. The SendPacketsElement class is used with the SocketAsyncEventArgs.SendPacketsElements property to get or set a data buffer or file to be sent using the Socket.SendPacketsAsync method.

Universal Naming Convention (UNC) paths are supported by the filepath parameter. If the file is in the current working directory, no path information needs to be specified.

.NET Framework
Available since 2.0
Return to top
Show: