WPX_FILTER_LOG Structure

The Forefront TMG Web proxy includes a pointer to the WPX_FILTER_LOG structure in the notification that it sends to Web filters when it is ready to write information to a log file. If your filter should be notified for this event, it must register to receive SF_NOTIFY_LOG notifications. For more information about the types of event notifications that are sent to Web filters, see Event Notifications.

Syntax

typedef struct _WPX_FILTER_LOG {

  const CHAR* pszClientHostName;

  const CHAR* pszClientUserName;

  const CHAR* pszServerName;

  const CHAR* pszOperation;

  const CHAR* pszTarget;

  const CHAR* pszParameters;

  DWORD dwHttpStatus;

  DWORD dwWin32Status;

  DWORD dwBytesSent;

  DWORD dwBytesRecvd;

  DWORD msTimeForProcessing;

  DWORD dwBytesSentHigh;

  DWORD dwBytesRecvdHigh;
} WPX_FILTER_LOG, 

 *PWPX_FILTER_LOG;

Members

pszClientHostName

The client's host name or IP address.

pszClientUserName

Null-terminated string that specifies the client's user name if authenticated, or "anonymous" otherwise.

pszServerName

Null-terminated string that specifies the name of the server to which the client is connected.

pszOperation

Null-terminated string that specifies the HTTP method.

pszTarget

Null-terminated string that specifies the target of the HTTP command.

pszParameters

Null-terminated string that specifies the parameters passed to the HTTP command. This member is used to store the information that is to written in the Filter Information field of a Web proxy log entry.

dwHttpStatus

The HTTP return status.

dwWin32Status

The Windows error code.

dwBytesSent

The number of bytes sent from the server to the client. This number represents the 32 least-significant bits.

dwBytesRecvd

The number of bytes received by the server from the client. This number represents the 32 least-significant bits.

msTimeForProcessing

The time, in milliseconds, required to process the client request.

dwBytesSentHigh

The number of bytes sent from the server to the client. This number represents the 32 most-significant bits.

dwBytesRecvdHigh

The number of bytes received by the server from the client. This number represents the 32 most-significant bits.

Remarks

When the Web proxy is about to log information to the Web proxy log, it sends a notification by calling the HttpFilterProc entry-point function of each Web filter that is registered to receive SF_NOTIFY_LOG event notifications. The pvNotification parameter contains a pointer to an WPX_FILTER_LOG structure, and the notificationType parameter is set to SF_NOTIFY_LOG.

The strings cannot be changed, but the string pointers can be replaced. If string pointers are changed, the memory they point to must remain valid until the next filter notification. The AllocMem callback function in the HTTP_FILTER_CONTEXT structure can be used to ensure this.

The strings specified in the pszClientHostName, pszClientUserName, pszServerName, pszOperation, pszTarget, and pszParameters members are formatted with UCS Transformation Format 8 (UTF-8) encoding.

For more information about how a Web filter can write information to the Web proxy log, see Adding Information to the Web Proxy Log.

Requirements

Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
Header	Declared in Httpfilt.h.

See Also

Notification Structures

Send comments about this topic to Microsoft

Build date: 11/30/2009