GetHeader

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This callback function is provided by the Web Server. ISAPI filters call this function to retrieve a header from the Web Server. The GetHeader name for this function is a placeholder for the function name defined by the header.

Syntax

BOOL (WINAPI* GetHeader)(
  PHTTP_FILTER_CONTEXT pfc, 
  LPSTR lpszName, 
  LPVOID lpvBuffer, 
  LPDWORD lpdwSize 
);

Parameters

• pfc
  [in] Pointer to an HTTP_FILTER_CONTEXT structure that is associated with the current, active HTTP transaction.

• lpszName
  [in] Pointer to the name of the header to retrieve.

• lpvBuffer
  [out] Pointer to a buffer of size lpdwSize where the value of the header will be stored. After the call, it contains the number of bytes retrieved including the null terminator. Therefore, for retrieved strings it is equal to strlen(lpvBuffer)+1.

• lpdwSize
  [in, out] The size of the buffer. This should be set to the size of the buffer lpvBuffer, for example, sizeof(achBuffer).

Return Value

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

Remarks

Header names should include the trailing colon (:). The special values method, URL, and version can be used to retrieve the individual portions of the request line. The special values must not include the trailing colon.

Requirements

See Also

Reference

HTTP_FILTER_CONTEXT