Metode IHttpServer::GetFileInfo

Mengembalikan antarmuka IHttpFileInfo untuk jalur file tertentu.

Sintaks

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;

Parameter

pszPhysicalPath
[IN] Penunjuk ke string yang berisi jalur fisik ke file.

hUserToken
[IN] HANDLE yang berisi token untuk pengguna peniruan identitas; jika tidak, NULL.

pSid
[IN] Penunjuk ke pengidentifikasi keamanan (SID) yang berisi ID keamanan untuk pengguna peniruan identitas; jika tidak, NULL.

pszVrPath
[IN] Penunjuk ke string yang berisi jalur virtual untuk mendaftar pemberitahuan perubahan; jika tidak, NULL.

hVrToken
[IN] HANDLE yang berisi token peniruan untuk mendaftar pemberitahuan perubahan; jika tidak, NULL.

fCache
[IN] true untuk menunjukkan bahwa file harus di-cache; jika tidak, false.

ppFileInfo
[OUT] Penunjuk dereferensi ke IHttpFileInfo antarmuka.

pHttpTraceContext
[IN] Penunjuk ke antarmuka IHttpTraceContext opsional.

Tampilkan Nilai

Sebuah HRESULT. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut.

Nilai	Definisi
S_OK	Menunjukkan bahwa operasi berhasil.
E_FAIL	Menunjukkan bahwa panggilan ke `GetFileInfo` dilakukan saat host modul berakhir.

Keterangan

Metode ini IHttpServer::GetFileInfo membuat IHttpFileInfo antarmuka untuk jalur tertentu. Metode ini berbeda dari metode IHttpContext::GetFileInfo , yang mengembalikan antarmuka untuk file yang sedang diproses IHttpFileInfo IIS dalam konteks permintaan.

Parameter pszPhysicalPath dan ppFileInfo diperlukan untuk membuat IHttpFileInfo antarmuka. Parameter pszPhysicalPath menentukan jalur ke file, dan ppFileInfo parameter menentukan pointer yang akan diisi IIS dengan antarmuka yang IHttpFileInfo sesuai.

Parameter pszVrPath dan hVrToken bersifat opsional, dan Anda harus mengaturnya ke NULL jika Anda tidak menggunakannya. Parameter ini menentukan, masing-masing, jalur virtual dan token peniruan identitas yang akan digunakan saat modul mendaftar untuk pemberitahuan perubahan (misalnya, jika Anda meminta penembolokan dengan mengatur fCache parameter ke true).

Catatan

Pengaturan konfigurasi lainnya dapat mencegah IIS men-cache file, bahkan jika Anda menentukan true untuk fCache parameter .

Parameter hUserToken dan pSid juga opsional, dan Anda harus mengaturnya ke NULL jika Anda tidak menggunakannya. Parameter ini menentukan, masing-masing, token dan SID untuk pengguna peniruan. Parameter opsional yang tersisa, pHttpTraceContext, menentukan IHttpTraceContext antarmuka untuk pelacakan.

Contoh

Contoh kode berikut menunjukkan cara membuat modul HTTP yang melakukan tugas berikut:

Mendaftar untuk pemberitahuan RQ_BEGIN_REQUEST .
Membuat kelas CHttpModule yang berisi metode OnBeginRequest . Saat klien meminta file, OnBeginRequest metode melakukan tugas berikut:
1. Memetakan jalur ke URL relatif dengan menggunakan metode IHttpContext::MapPath .
2. IHttpFileInfo Membuat antarmuka untuk jalur file dengan menggunakan IHttpServer::GetFileInfo metode .
3. Mengambil tag entitas untuk file dengan menggunakan metode IHttpFileInfo::GetETag .
4. Mengembalikan tag entitas ke klien dengan menggunakan metode IHttpResponse::WriteEntityChunks .
CHttpModule Menghapus kelas dari memori lalu keluar.

#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
    );
}

Untuk informasi selengkapnya tentang cara membuat dan menyebarkan modul DLL asli, lihat Panduan: Membuat modul HTTP Request-Level Dengan Menggunakan Kode Asli.

Anda dapat secara opsional mengkompilasi kode dengan menggunakan __stdcall (/Gz) konvensi panggilan alih-alih secara eksplisit mendeklarasikan konvensi panggilan untuk setiap fungsi.

Persyaratan

Jenis	Deskripsi
Klien	- IIS 7.0 di Windows Vista - IIS 7.5 di Windows 7 - IIS 8.0 di Windows 8 - IIS 10.0 pada Windows 10
Server	- IIS 7.0 di Windows Server 2008 - IIS 7.5 di Windows Server 2008 R2 - IIS 8.0 di Windows Server 2012 - IIS 8.5 di Windows Server 2012 R2 - IIS 10.0 di Windows Server 2016
Produk	- 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
Header	Httpserv.h

Lihat juga

Antarmuka IHttpServer
Metode IHttpContext::GetFileInfo

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2023-07-19