IHttpContext::GetServerVariable, méthode

Article
07/19/2023

Récupère une variable de serveur spécifique.

Syntaxe

virtual HRESULT GetServerVariable(  
   PCSTR pszVariableName,  
   PCWSTR * ppszValue,  
   DWORD * pcchValueLength  
) = 0;  
virtual HRESULT GetServerVariable(  
   PCSTR   pszVariableName,  
   PCSTR * ppszValue,  
   DWORD * pcchValueLength  
) = 0;

Paramètres

pszVariableName
Pointeur vers une chaîne qui contient le nom de la variable de serveur à retourner.

ppszValue
Adresse d’un pointeur vers une mémoire tampon de chaîne qui reçoit une copie de la variable de serveur.

pcchValueLengthr
Pointeur vers une DWORD mémoire tampon qui reçoit la longueur du ppszValue paramètre.

Valeur renvoyée

Élément HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Valeur	Description
S_OK	Indique que l’opération a réussi.
ERROR_INVALID_INDEX	Indique que le paramètre n’est pas valide.

Remarques

La GetServerVariable méthode récupère une variable de serveur spécifiée par le pszVariableName paramètre à partir du contexte HTTP actuel et retourne la valeur dans une mémoire tampon pointée par le ppszValue paramètre . La variable de serveur spécifiée par le pszVariableName paramètre peut être une variable personnalisée ou une variable définie dans requests for comments (RFC) 3875, « The Common Gateway Interface (CGI) version 1.1 ».

Notes

La GetServerVariable méthode prend en charge le retour des valeurs ANSI et Unicode par le biais de méthodes surchargées. La mémoire tampon pointée par le ppszValue paramètre peut être une PCWSTR mémoire tampon ou PCSTR .

Spécifications

Type	Description
Client	- IIS 7.0 sur Windows Vista - IIS 7.5 sur Windows 7 - IIS 8.0 sur Windows 8 - IIS 10.0 sur Windows 10
Serveur	- IIS 7.0 sur Windows Server 2008 - IIS 7.5 sur Windows Server 2008 R2 - IIS 8.0 sur Windows Server 2012 - IIS 8.5 sur Windows Server 2012 R2 - IIS 10.0 sur Windows Server 2016
Produit	- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - IIS Express 7.5, IIS Express 8.0, IIS Express 10.0
En-tête	Httpserv.h

Voir aussi

IHttpContext, interface
IHttpContext::SetServerVariable, méthode

Partager via