Метод IHttpFileInfo::GetAttributes

Извлекает атрибуты соответствующего файла для интерфейса IHttpFileInfo .

Синтаксис

virtual DWORD GetAttributes(  
   VOID  
) const = 0;  

Параметры

Этот метод не принимает параметров.

Возвращаемое значение

Объект , DWORD содержащий значения атрибута файла.

Комментарии

Метод GetAttributes извлекает объект , DWORD содержащий битовую маску значений атрибутов для файла, на который в данный момент ссылается IHttpFileInfo интерфейс. Например, если вы создаете приложение, которое вызывает метод IHttpContext::GetFileInfo для получения IHttpFileInfo интерфейса, GetAttributes метод возвращает атрибуты файла, используемого для текущего запроса.

Пример

В следующем примере кода показано, как использовать IHttpContext::GetFileInfo метод для создания модуля HTTP, который получает указатель на IHttpFileInfo интерфейс для текущего запроса. Затем в примере вызывается GetAttributes метод для получения атрибутов для запрошенного файла и определяется состояние атрибутов , доступных только для чтения, скрытых и архивных атрибутов. Наконец, в примере эти сведения отображаются в веб-клиенте.

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );
        
        // Get a pointer to an IHttpFileInfo class.
        IHttpFileInfo * pHttpFileInfo = pHttpContext->GetFileInfo();

        // Test for an error.
        if (NULL != pHttpFileInfo)
        {
            // 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);

            // Retrieve the file attributes.
            DWORD dwFileAttributes = pHttpFileInfo->GetAttributes();

            // Return the status of the "read-only" attribute.
            WriteResponseMessage(pHttpContext,"\nRead only: ",
                (dwFileAttributes & _A_RDONLY) ? "Yes" : "No");

            // Return the status of the "hidden" attribute.
            WriteResponseMessage(pHttpContext,"\nHidden: ",
                (dwFileAttributes & _A_HIDDEN) ? "Yes" : "No");

            // Return the status of the "archive" attribute.
            WriteResponseMessage(pHttpContext,"\nArchive: ",
                (dwFileAttributes & _A_ARCH) ? "Yes" : "No");

            // 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.
        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 );
    UNREFERENCED_PARAMETER( pGlobalInfo );

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

Модуль должен экспортировать функцию RegisterModule . Эту функцию можно экспортировать, создав файл определения модуля (DEF- файл) для проекта, или скомпилировать модуль с помощью /EXPORT:RegisterModule параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля HTTP Request-Level с помощью машинного кода.

При необходимости можно скомпилировать код с помощью __stdcall (/Gz) соглашения о вызовах вместо явного объявления соглашения о вызовах для каждой функции.

Требования

См. также:

Интерфейс IHttpFileInfo