WriteClient (ISAPI Extensions)

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The ISAPI extension calls this function to send data to the HTTP client. The WriteClient name for this function is a placeholder for the function name defined by the header.

Syntax

BOOL (WINAPI* WriteClient)(
  HCONN ConnID,
  LPVOID Buffer,
  LPDWORD lpdwBytes,
  DWORD dwReserved 
);

Parameters

• ConnID
  [in] Connection identifier of the client to which the response data should be sent.

• Buffer
  [in] Pointer to the data to be sent.

• lpdwBytes
  [in, out] Pointer to the number of bytes from the buffer that will be written to the client when the call is made. On completion, this parameter contains the number of bytes successfully sent out for synchronous write operations. For asynchronous write operations the retrieved value has no meaning.

• dwReserved
  [in] Reserved for future use.

Return Value

Returns TRUE if the function succeeds, and FALSE otherwise. To determine the cause of a failure, the extension should call GetLastError.

Remarks

This function attempts to write the data in the supplied buffer to the same socket that was used for the client request. For synchronous writes, it attempts to write in the calling thread. The thread may become blocked while trying to send the data to client. On completion, WriteClient returns the number of bytes sent in *lpdwBytes.

Requirements