filter.c File Reference

#include <kmt_test.h>
#include "kmtest.h"
#include <assert.h>

Include dependency graph for filter.c:

Go to the source code of this file.

Macros
#define	SERVICE_ACCESS   (SERVICE_START | SERVICE_STOP | DELETE)

Functions
KmtFltLoad
Start the specified filter driver by name Parameters ServiceName The name of the filter to start Returns Win32 error code
DWORD	KmtFltLoad (_In_z_ PCWSTR ServiceName)
KmtFltConnect
Create a comms connection to the specified filter Parameters ServiceName Name of the filter to connect to hPort Handle to the filter's comms port Returns Win32 error code
DWORD	KmtFltConnect (_In_z_ PCWSTR ServiceName, _Out_ HANDLE *hPort)
KmtFltDisconnect
Disconenct from the comms port Parameters hPort Handle to the filter's comms port Returns Win32 error code
DWORD	KmtFltDisconnect (_In_ HANDLE hPort)
KmtFltSendMessage
Sneds a message to a filter driver Parameters hPort Handle to the filter's comms port @InBuffer Pointer to a buffer to send to the filter @InBufferSize Size of the buffer pointed to by InBuffer @OutBuffer Pointer to a buffer to receive reply data from the filter @OutBufferSize Size of the buffer pointed to by OutBuffer @BytesReturned Number of bytes written in the reply buffer Returns Win32 error code
DWORD	KmtFltSendMessage (_In_ HANDLE hPort, _In_reads_bytes_(dwInBufferSize) LPVOID InBuffer, _In_ DWORD InBufferSize, _Out_writes_bytes_to_opt_(dutBufferSize, *BytesReturned) LPVOID OutBuffer, _In_ DWORD OutBufferSize, _Out_opt_ LPDWORD BytesReturned)
KmtFltGetMessage
Gets a message from a filter driver Parameters hPort Handle to the filter's comms port @MessageBuffer Pointer to a buffer to receive the data from the filter @MessageBufferSize Size of the buffer pointed to by MessageBuffer @Overlapped Pointer to an overlapped structure Returns Win32 error code
DWORD	KmtFltGetMessage (_In_ HANDLE hPort, _Out_writes_bytes_(MessageBufferSize) PFILTER_MESSAGE_HEADER MessageBuffer, _In_ DWORD MessageBufferSize, _In_opt_ LPOVERLAPPED Overlapped)
KmtFltReplyMessage
Replies to a message from a filter driver Parameters hPort Handle to the filter's comms port @ReplyBuffer Pointer to a buffer to return to the filter @ReplyBufferSize Size of the buffer pointed to by ReplyBuffer Returns Win32 error code
DWORD	KmtFltReplyMessage (_In_ HANDLE hPort, _In_reads_bytes_(ReplyBufferSize) PFILTER_REPLY_HEADER ReplyBuffer, _In_ DWORD ReplyBufferSize)
KmtFltGetMessageResult
Gets the overlapped result from the IO Parameters hPort Handle to the filter's comms port @Overlapped Pointer to the overlapped structure usdd in the IO @BytesTransferred Number of bytes transferred in the IO Returns Win32 error code
DWORD	KmtFltGetMessageResult (_In_ HANDLE hPort, _In_ LPOVERLAPPED Overlapped, _Out_ LPDWORD BytesTransferred)
KmtFltUnload
Unload the specified filter driver Parameters ServiceName The name of the filter to unload Returns Win32 error code
DWORD	KmtFltUnload (_In_z_ PCWSTR ServiceName)

Macro Definition Documentation

SERVICE_ACCESS

#define SERVICE_ACCESS   (SERVICE_START | SERVICE_STOP | DELETE)

Definition at line 15 of file filter.c.

Function Documentation

KmtFltConnect()

DWORD KmtFltConnect	(	_In_z_ PCWSTR	ServiceName,
		_Out_ HANDLE *	hPort
	)

Definition at line 119 of file filter.c.

{
    HRESULT hResult;
    DWORD Error;
 
    assert(ServiceName);
    assert(hPort);
 
    hResult = FilterConnectCommunicationPort(ServiceName,
                                             0,
                                             NULL,
                                             0,
                                             NULL,
                                             hPort);
    Error = SCODE_CODE(hResult);
 
    return Error;
}

Referenced by KmtFltConnectComms().

KmtFltDisconnect()

DWORD KmtFltDisconnect

(

_In_ HANDLE

hPort

)

Definition at line 151 of file filter.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    assert(hPort);
 
    if (!CloseHandle(hPort))
    {
        Error = GetLastError();
    }
 
    return Error;
}

Referenced by KmtFltDisconnectComms(), and KmtFltUnloadDriver().

KmtFltGetMessage()

DWORD KmtFltGetMessage	(	_In_ HANDLE	hPort,
		_Out_writes_bytes_(MessageBufferSize) PFILTER_MESSAGE_HEADER	MessageBuffer,
		_In_ DWORD	MessageBufferSize,
		_In_opt_ LPOVERLAPPED	Overlapped
	)

Definition at line 241 of file filter.c.

{
    HRESULT hResult;
    DWORD Error;
 
    assert(hPort);
    assert(MessageBuffer);
 
    hResult = FilterGetMessage(hPort,
                               MessageBuffer,
                               MessageBufferSize,
                               Overlapped);
    Error = SCODE_CODE(hResult);
    return Error;
}

KmtFltGetMessageResult()

DWORD KmtFltGetMessageResult	(	_In_ HANDLE	hPort,
		_In_ LPOVERLAPPED	Overlapped,
		_Out_ LPDWORD	BytesTransferred
	)

Definition at line 306 of file filter.c.

{
    BOOL Success;
    DWORD Error = ERROR_SUCCESS;
 
    *BytesTransferred = 0;
 
    Success = GetOverlappedResult(hPort, Overlapped, BytesTransferred, TRUE);
    if (!Success)
    {
        Error = GetLastError();
    }
 
    return Error;
}

KmtFltLoad()

DWORD KmtFltLoad

(

_In_z_ PCWSTR

ServiceName

)

Definition at line 30 of file filter.c.

{
    HRESULT hResult;
    DWORD Error = ERROR_SUCCESS;
 
    assert(ServiceName);
 
    hResult = FilterLoad(ServiceName);
    Error = SCODE_CODE(hResult);
 
    return Error;
}

Referenced by KmtFltLoadDriver().

KmtFltReplyMessage()

DWORD KmtFltReplyMessage	(	_In_ HANDLE	hPort,
		_In_reads_bytes_(ReplyBufferSize) PFILTER_REPLY_HEADER	ReplyBuffer,
		_In_ DWORD	ReplyBufferSize
	)

Definition at line 276 of file filter.c.

{
    HRESULT hResult;
    DWORD Error;
 
    hResult = FilterReplyMessage(hPort,
                                 ReplyBuffer,
                                 ReplyBufferSize);
    Error = SCODE_CODE(hResult);
    return Error;
}

KmtFltSendMessage()

DWORD KmtFltSendMessage	(	_In_ HANDLE	hPort,
		_In_reads_bytes_(dwInBufferSize) LPVOID	InBuffer,
		_In_ DWORD	InBufferSize,
		_Out_writes_bytes_to_opt_(dutBufferSize, *BytesReturned) LPVOID	OutBuffer,
		_In_ DWORD	OutBufferSize,
		_Out_opt_ LPDWORD	BytesReturned
	)

Definition at line 187 of file filter.c.

{
    DWORD BytesRet;
    HRESULT hResult;
    DWORD Error;
 
    assert(hPort);
    assert(InBuffer);
    assert(InBufferSize);
 
    if (BytesReturned) *BytesReturned = 0;
 
    hResult = FilterSendMessage(hPort,
                                InBuffer,
                                InBufferSize,
                                OutBuffer,
                                OutBufferSize,
                                &BytesRet);
 
    Error = SCODE_CODE(hResult);
    if (Error == ERROR_SUCCESS)
    {
        if (BytesRet)
        {
            *BytesReturned = BytesRet;
        }
    }
 
    return Error;
}

Referenced by KmtFltSendBufferToDriver().

KmtFltUnload()

DWORD KmtFltUnload

(

_In_z_ PCWSTR

ServiceName

)

Definition at line 336 of file filter.c.

{
    HRESULT hResult;
    DWORD Error = ERROR_SUCCESS;
 
    assert(ServiceName);
 
    hResult = FilterUnload(ServiceName);
    Error = SCODE_CODE(hResult);
 
    return Error;
}

Referenced by KmtFltLoadDriver(), and KmtFltUnloadDriver().