Share via

SetHeader

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This callback function is an application-defined function. ISAPI filters call this function to change or delete the value of a header. The SetHeader name for this function is a placeholder for the function name defined by the header.

This function can be used to change the special values included in the request line. For more information about the limitations of this function, see ISAPI Filters and HTTP Headers.

Syntax

BOOL (WINAPI* SetHeader)(
  PHTTP_FILTER_CONTEXT pfc, 
  LPSTR lpszName, 
  LPSTR lpszValue 
);

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 change or delete.
  • lpszValue
    [in] Pointer to the new string for the header, or to "\0" (to delete the header).

Return Value

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

Requirements

Header httpfilt.h
Library Developer Implemented
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Pocket PC 2000 and later, Smartphone 2002 and later

See Also

Reference

HTTP_FILTER_CONTEXT

Concepts

ISAPI Filters and HTTP Headers