IHttpContext::ExecuteRequest, méthode

Article
07/19/2023

Exécute une requête enfant.

Syntaxe

virtual HRESULT ExecuteRequest(  
   IN BOOL fAsync,  
   IN IHttpContext* pHttpContext,  
   IN DWORD dwExecuteFlags,  
   IN IHttpUser* pHttpUser,  
   OUT BOOL* pfCompletionExpected = NULL  
) = 0;

Paramètres

fAsync
[IN] Always true (spécifie l’exécution asynchrone).

pHttpContext
[IN] Pointeur vers le IHttpContext enfant à exécuter.

dwExecuteFlags
[IN] qui contient les indicateurs d’exécution DWORD de la demande.

pHttpUser
[IN] Pointeur vers un IHttpUser pour la demande. (facultatif)

pfCompletionExpected
[OUT] true si l’achèvement asynchrone est toujours en attente ; sinon, false. (facultatif)

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_NOT_SUPPORTED	Indique que la requête n’est pas prise en charge (par exemple, `fAsync` est définie sur `false` ou la requête enfant n’a pas été cloné à partir de la requête parente).
ERROR_STACK_OVERFLOW	Indique que la requête dépasse la limite pour les requêtes enfants récursives.

Remarques

La ExecuteRequest méthode exécute la requête enfant spécifiée par l’interface IHttpContext dans le pHttpContext paramètre . Vous devez créer ce contexte de requête à l’aide de la méthode IHttpContext::CloneContext .

Important

La tentative d’exécution d’une requête enfant qui n’a pas été cloné par la requête parente retourne ERROR_NOT_SUPPORTED.

Chaque contexte enfant ne peut être exécuté qu’une seule fois, bien que les requêtes enfants puissent être imbriquées de manière récursive.

Notes

La limite pour les requêtes enfants récursives est de 10.

La ExecuteRequest méthode prend uniquement en charge l’opération asynchrone, ce qui empêche d’épuiser le pool de threads.

Important

La tentative d’exécution d’une requête enfant synchrone retourne ERROR_NOT_SUPPORTED.

Vous pouvez contrôler le comportement d’exécution de la requête enfant en spécifiant des indicateurs d’exécution dans dwExecuteFlags. Le tableau suivant répertorie les valeurs possibles pour ces indicateurs.

Valeur	Description
EXECUTE_FLAG_NO_HEADERS	Supprimez les en-têtes HTTP de la requête enfant.
EXECUTE_FLAG_IGNORE_CURRENT_INTERCEPTOR	Ignorez le gestionnaire de mappage de script actuel pour cette chaîne de requêtes.
EXECUTE_FLAG_IGNORE_APPPOOL	Exécutez la demande même si la requête enfant ne se trouve pas dans le même pool d’applications.
EXECUTE_FLAG_DISABLE_CUSTOM_ERROR	Désactivez les erreurs personnalisées pour la requête enfant.
EXECUTE_FLAG_SAME_URL	L’URL de la requête enfant est identique à la requête parente. Note: Les gestionnaires de mappage de script utilisent cet indicateur pour transférer l’exécution.
EXECUTE_FLAG_BUFFER_RESPONSE	Ne videz pas la réponse enfant ; retourne la réponse à la demande parente.
EXECUTE_FLAG_HTTP_CACHE_ELIGIBLE	La réponse enfant est toujours éligible à la mise en cache par Http.sys. Note: La mise en cache est désactivée par défaut lorsqu’une requête enfant est exécutée.

Si vous spécifiez une IHttpUser interface pour pHttpUser, l’authentification sera ignorée pour la requête enfant.

Exemple

L’exemple de code suivant montre comment créer un module HTTP qui effectue les tâches suivantes :

Le module s’inscrit pour la notification RQ_MAP_PATH .
Le module crée une classe CHttpModule qui contient des méthodes OnMapPath et OnAsyncCompletion .
Lorsqu’un client Web demande une URL, IIS appelle la méthode du OnMapPath module. Cette méthode effectue les tâches suivantes :
1. Teste pour voir si l’URL de la requête actuelle correspond à deux URL spécifiques à la racine du site Web. Si l’URL correspond à l’une des URL spécifiées, le module utilise la IHttpContext::CloneContext méthode pour créer un clone de la requête actuelle.
2. Appelle la méthode du IHttpRequest::SetUrl clone pour définir l’URL du clone sur /example/default.aspx.
3. Appelle la ExecuteRequest méthode pour exécuter la requête enfant.
4. Teste l’achèvement asynchrone. Si l’achèvement asynchrone est en attente, le module retourne le traitement au pipeline de traitement des demandes intégré. Si ce n’est pas le cas, le module libère le contexte cloné.
Si l’achèvement asynchrone est requis, IIS appelle la méthode du OnAsyncCompletion module. Cette méthode libère le contexte cloné.
Le module supprime la classe de la CHttpModule mémoire, puis se ferme.

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{

private:

    // Create a pointer for a child request.
    IHttpContext * m_pChildRequestContext;

public:

    MyHttpModule(void)
    {
        m_pChildRequestContext = NULL;
    }

    REQUEST_NOTIFICATION_STATUS
    OnMapPath(
        IN IHttpContext * pHttpContext,
        IN IMapPathProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        HRESULT hr;
        BOOL fCompletionExpected;

        // Retrieve a pointer to the URL.
        PCWSTR pwszUrl = pProvider->GetUrl();

        // Only process requests for the root.
        if (0 == wcscmp(pwszUrl,L"/") || 0 == wcscmp(pwszUrl,L"/default.aspx"))
        {            
            // Clone the current context.
            hr = pHttpContext->CloneContext(
                CLONE_FLAG_BASICS, &m_pChildRequestContext );
            
            // Test for a failure.
            if (FAILED(hr))
            {
                goto Failure;
            }
            
            // Test for an error.
            if ( NULL != m_pChildRequestContext )
            {
                // Set the URL for the child request.
                hr = m_pChildRequestContext->GetRequest()->SetUrl(
                    "/example/default.aspx",
                    (DWORD)strlen("/example/default.aspx"),false);
            
                // Test for a failure.
                if (FAILED(hr))
                {
                    goto Failure;
                }
                
                // Execute the child request.
                hr = pHttpContext->ExecuteRequest(
                    TRUE, m_pChildRequestContext,
                    0, NULL, &fCompletionExpected );
                
                // Test for a failure.
                if (FAILED(hr))
                {
                    goto Failure;
                }
                
                // Test for pending asynchronous operations.
                if (fCompletionExpected)
                {
                    return RQ_NOTIFICATION_PENDING;
                }

            }

 Failure:
            // Test for a child request.
            if (NULL != m_pChildRequestContext)
            {
                // Release the child request.
                m_pChildRequestContext->ReleaseClonedContext();
                m_pChildRequestContext = NULL;
            }
        }
        
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
    
    REQUEST_NOTIFICATION_STATUS
        OnAsyncCompletion(
        IN IHttpContext * pHttpContext,
        IN DWORD dwNotification,
        IN BOOL fPostNotification,
        IN IHttpEventProvider * pProvider,
        IN IHttpCompletionInfo * pCompletionInfo
        )
    {
        // Test for a child request.
        if (NULL != m_pChildRequestContext)
        {
            // Release the child request.
            m_pChildRequestContext->ReleaseClonedContext();
            m_pChildRequestContext = NULL;
        }
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if we cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_MAP_PATH,
        0
    );
}

Votre module doit exporter la fonction RegisterModule . Vous pouvez exporter cette fonction en créant un fichier de définition de module (.def) pour votre projet, ou vous pouvez compiler le module à l’aide du /EXPORT:RegisterModule commutateur. Pour plus d’informations, consultez Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif.

Vous pouvez éventuellement compiler le code à l’aide de la __stdcall (/Gz) convention d’appel au lieu de déclarer explicitement la convention d’appel pour chaque fonction.

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::CloneContext, méthode
IHttpContext::GetParentContext, méthode
IHttpContext::ReleaseClonedContext, méthode

Partager via