HSE_APPEND_LOG_PARAMETER

  • Article

You can use this support function to write your own custom log strings to the log record. When this function is called, the string contained in the buffer you specify is appended to the log record for the current HTTP request.

BOOL ServerSupportFunction(
   HCONN ConnID,
   DWORD dwServerSupportFunction,
   LPVOID lpvBuffer,
   LPDWORD lpdwSizeofBuffer,
   LPDWORD lpdwDataType
);

Parameters

  • ConnID
    Specifies the connection identifier of the client to which the response data should be sent.

  • dwServerSupportFunction
    The name of the Server Support function, which in this case must be set to HSE_APPEND_LOG_PARAMETER.

  • lpvBuffer
    Points to a null-terminated string that should be appended to the log record.

  • lpdwSizeofBuffer
    Points to the DWORD containing the size of the string contained in the buffer lpvBuffer.

  • lpdwDataType
    Unused in this ServerSupportFunction request type.

Remarks

If you are using the W3C Extended Log File Format as your active log format, your log string will not be written to the %windir%\system32\Logfiles\W3SVC1\xxx.log file unless the URI Query (cs-uri-query) field is enabled. The HSE_APPEND_LOG_PARAMETER is logged in the URI Query field, which is not enabled in the extended logging properties by default. However, NCSA Common Log File Format as your active log format will always show the appended log string.

Requirements

Client: Requires Windows XP Professional, Windows 2000 Professional, or Windows NT Workstation 4.0.

Server: Requires Windows Server 2003, Windows 2000 Server, or Windows NT Server 4.0.

Product: IIS

Header: Declared in httpext.h.