IHttpServer::GetFileInfo, méthode

Article
07/19/2023

Renvoie une interface IHttpFileInfo pour un chemin de fichier spécifique.

Syntaxe

virtual HRESULT GetFileInfo(  
   IN PCWSTR pszPhysicalPath,  
   IN HANDLE hUserToken,  
   IN PSID pSid,  
   IN PCWSTR pszVrPath,  
   IN HANDLE hVrToken,  
   IN BOOL fCache,  
   OUT IHttpFileInfo** ppFileInfo,  
   IN IHttpTraceContext* pHttpTraceContext = NULL  
) = 0;

Paramètres

pszPhysicalPath
[IN] Pointeur vers une chaîne qui contient le chemin physique d’un fichier.

hUserToken
[IN] HANDLE qui contient le jeton de l’utilisateur d’emprunt d’identité ; sinon, NULL.

pSid
[IN] Pointeur vers un identificateur de sécurité (SID) qui contient l’ID de sécurité de l’utilisateur d’emprunt d’identité ; sinon, NULL.

pszVrPath
[IN] Pointeur vers une chaîne qui contient le chemin d’accès virtuel pour s’inscrire aux notifications de modification ; sinon, NULL.

hVrToken
[IN] HANDLE qui contient le jeton d’emprunt d’identité pour s’inscrire aux notifications de modification ; sinon, NULL.

fCache
[IN] true pour indiquer que le fichier doit être mis en cache ; sinon, false.

ppFileInfo
[OUT] Pointeur déréférencé vers une IHttpFileInfo interface.

pHttpTraceContext
[IN] Pointeur vers une interface IHttpTraceContext facultative.

Valeur renvoyée

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

Valeur	Définition
S_OK	Indique que l’opération a réussi.
E_FAIL	Indique que l’appel à `GetFileInfo` a été effectué pendant la fin de l’hôte du module.

Remarques

La IHttpServer::GetFileInfo méthode crée une IHttpFileInfo interface pour un chemin d’accès spécifique. Cette méthode diffère de la méthode IHttpContext::GetFileInfo , qui retourne une IHttpFileInfo interface pour le fichier traité par IIS dans un contexte de requête.

Les pszPhysicalPath paramètres et ppFileInfo sont requis pour créer une IHttpFileInfo interface. Le pszPhysicalPath paramètre spécifie le chemin d’accès au fichier, et le paramètre définit le ppFileInfo pointeur que IIS remplira avec l’interface correspondante IHttpFileInfo .

Les pszVrPath paramètres et hVrToken sont facultatifs, et vous devez les définir sur NULL si vous ne les utilisez pas. Ces paramètres spécifient, respectivement, le chemin d’accès virtuel et le jeton d’emprunt d’identité à utiliser lorsqu’un module s’inscrit pour les notifications de modification (par exemple, si vous demandez la mise en cache en définissant le fCache paramètre sur true).

Notes

D’autres paramètres de configuration peuvent empêcher IIS de mettre en cache le fichier, même si vous spécifiez true pour le fCache paramètre.

Les hUserToken paramètres et pSid sont également facultatifs, et vous devez les définir sur NULL si vous ne les utilisez pas. Ces paramètres spécifient, respectivement, le jeton et le SID pour l’utilisateur d’emprunt d’identité. Le paramètre facultatif restant, pHttpTraceContext, spécifie l’interface pour le IHttpTraceContext suivi.

Exemple

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

S’inscrit à la notification RQ_BEGIN_REQUEST .
Crée une classe CHttpModule qui contient une méthode OnBeginRequest . Lorsqu’un client demande un fichier, la OnBeginRequest méthode effectue les tâches suivantes :
1. Mappe un chemin d’accès à une URL relative à l’aide de la méthode IHttpContext::MapPath .
2. Crée une IHttpFileInfo interface pour le chemin du fichier à l’aide de la IHttpServer::GetFileInfo méthode .
3. Récupère la balise d’entité du fichier à l’aide de la méthode IHttpFileInfo::GetETag .
4. Retourne la balise d’entité au client à l’aide de la méthode IHttpResponse::WriteEntityChunks .
Supprime la classe de la CHttpModule mémoire, puis se ferme.

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

// Create a pointer for the global server interface.
IHttpServer * g_pHttpServer = NULL;

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        HRESULT hr;

        PWSTR wszUrl = L"/example/default.asp";
        WCHAR wszPhysicalPath[1024] = L"";
        DWORD cbPhysicalPath = 1024;

        pHttpContext->MapPath(wszUrl,wszPhysicalPath,&cbPhysicalPath);

        if (NULL != wszPhysicalPath)
        {
            IHttpFileInfo * pHttpFileInfo;
            hr = g_pHttpServer->GetFileInfo(wszPhysicalPath,
                NULL,NULL,wszUrl,NULL,TRUE,&pHttpFileInfo);
            if (NULL != pHttpFileInfo)
            {
                // Create a buffer for the Etag.
                USHORT cchETag;
                // Retrieve the Etag.
                PCSTR pszETag = pHttpFileInfo->GetETag(&cchETag);
                //Test for an error.
                if (NULL != pszETag)
                {
                    // Clear the existing response.
                    pHttpContext->GetResponse()->Clear();
                    // Set the MIME type to plain text.
                    pHttpContext->GetResponse()->SetHeader(
                        HttpHeaderContentType,"text/plain",
                        (USHORT)strlen("text/plain"),TRUE);
                    // Return the Etag to the client.
                    WriteResponseMessage(pHttpContext,
                        "ETag: ",pszETag);
                    // End additional processing.
                    return RQ_NOTIFICATION_FINISH_REQUEST;
                }
            }
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk. (Defined in the Http.h file.)
        HTTP_DATA_CHUNK dataChunk;
        // Set the chunk to a chunk in memory.
        dataChunk.DataChunkType = HttpDataChunkFromMemory;
        // Buffer for bytes written of data chunk.
        DWORD cbSent;

        // Set the chunk to the first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

// 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 the factory 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 );

    // Store the pointer for the global server interface.
    g_pHttpServer = pGlobalInfo;

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

Pour plus d’informations sur la création et le déploiement d’un module DLL natif, 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

IHttpServer Interface
IHttpContext::GetFileInfo, méthode

Partager via