GetServerVariable (ISAPI Filters)

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 retrieve information about an HTTP connection or about the Windows Embedded CE Web Server. The GetServerVariable name for this function is a placeholder for the function name defined by the header.

Syntax

BOOL (WINAPI* GetServerVariable) (
  PHTTP_FILTER_CONTEXT pfc,
  LPSTR lpszVariableName,
  LPVOID lpvBuffer,
  LPDWORD lpdwSize
);

Parameters

  • pfc
    [in] Pointer to an HTTP_FILTER_CONTEXT structure that is associated with the current, active HTTP transaction.
  • lpszVariableName
    [in] Pointer to the variable to retrieve.
  • lpvBuffer
    [out] Pointer to the buffer to receive the requested information.
  • lpdwSize
    [in. out] Pointer to the size of the buffer indicated by lpvBuffer. On successful completion, the parameter contains the size of bytes transferred into the buffer, including the null-terminating byte.

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

Web Server Functions