CAsyncSocket::Send

virtual int Send( const void* lpBuf, int nBufLen, int nFlags = 0 );

Return Value

If no error occurs, Send returns the total number of characters sent. (Note that this can be less than the number indicated by nBufLen.) Otherwise, a value of SOCKET_ERROR is returned, and a specific error code can be retrieved by calling GetLastError. The following errors apply to this member function:

• WSANOTINITIALISED   A successful AfxSocketInit must occur before using this API.
  
  
• WSAENETDOWN   The Windows Sockets implementation detected that the network subsystem failed.
  
  
• WSAEACCES   The requested address is a broadcast address, but the appropriate flag was not set.
  
  
• WSAEINPROGRESS   A blocking Windows Sockets operation is in progress.
  
  
• WSAEFAULT   The lpBuf argument is not in a valid part of the user address space.
  
  
• WSAENETRESET   The connection must be reset because the Windows Sockets implementation dropped it.
  
  
• WSAENOBUFS   The Windows Sockets implementation reports a buffer deadlock.
  
  
• WSAENOTCONN   The socket is not connected.
  
  
• WSAENOTSOCK   The descriptor is not a socket.
  
  
• WSAEOPNOTSUPP   MSG_OOB was specified, but the socket is not of type SOCK_STREAM.
  
  
• WSAESHUTDOWN   The socket has been shut down; it is not possible to call Send on a socket after ShutDown has been invoked with nHow set to 1 or 2.
  
  
• WSAEWOULDBLOCK   The socket is marked as nonblocking and the requested operation would block.
  
  
• WSAEMSGSIZE   The socket is of type SOCK_DGRAM, and the datagram is larger than the maximum supported by the Windows Sockets implementation.
  
  
• WSAEINVAL   The socket has not been bound with Bind.
  
  
• WSAECONNABORTED   The virtual circuit was aborted due to timeout or other failure.
  
  
• WSAECONNRESET   The virtual circuit was reset by the remote side.

Parameters

lpBuf

A buffer containing the data to be transmitted.

nBufLen

The length of the data in lpBuf in bytes.

nFlags

Specifies the way in which the call is made. The semantics of this function are determined by the socket options and the nFlags parameter. The latter is constructed by combining any of the following values with the C++ OR operator:

• MSG_DONTROUTE   Specifies that the data should not be subject to routing. A Windows Sockets supplier can choose to ignore this flag; see also the discussion of the SO_DONTROUTE option in Windows Sockets Programming Considerations in the Win32 SDK documentation.
  
  
• MSG_OOB   Send out-of-band data (SOCK_STREAM only).

Remarks

Call this member function to send data on a connected socket. Send is used to write outgoing data on connected stream or datagram sockets. For datagram sockets, care must be taken not to exceed the maximum IP packet size of the underlying subnets, which is given by the iMaxUdpDg element in the WSADATA structure returned by AfxSocketInit. If the data is too long to pass atomically through the underlying protocol, the error WSAEMSGSIZE is returned via GetLastError, and no data is transmitted.

Note that for a datagram socket the successful completion of a Send does not indicate that the data was successfully delivered.

On CAsyncSocket objects of type SOCK_STREAM, the number of bytes written can be between 1 and the requested length, depending on buffer availability on both the local and foreign hosts.

Example

See the example for CAsyncSocket::OnSend.

CAsyncSocket Overview |  Class Members |  Hierarchy Chart

See Also   CAsyncSocket::Create, CAsyncSocket::Receive, CAsyncSocket::ReceiveFrom, CAsyncSocket::SendTo