icmpapi.h File Reference

Go to the source code of this file.

Macros
#define	IPHLPAPI_DLL_LINKAGE

Functions
IPHLPAPI_DLL_LINKAGE HANDLE WINAPI	IcmpCreateFile (VOID)
IPHLPAPI_DLL_LINKAGE HANDLE WINAPI	Icmp6CreateFile (VOID)
IPHLPAPI_DLL_LINKAGE BOOL WINAPI	IcmpCloseHandle (_In_ HANDLE IcmpHandle)
IPHLPAPI_DLL_LINKAGE DWORD WINAPI	IcmpSendEcho (_In_ HANDLE IcmpHandle, _In_ IPAddr DestinationAddress, _In_reads_bytes_(RequestSize) LPVOID RequestData, _In_ WORD RequestSize, _In_opt_ PIP_OPTION_INFORMATION RequestOptions, _Out_writes_bytes_(ReplySize) LPVOID ReplyBuffer, _In_range_(>=, sizeof(ICMP_ECHO_REPLY)+RequestSize+8) DWORD ReplySize, _In_ DWORD Timeout)
IPHLPAPI_DLL_LINKAGE DWORD WINAPI	IcmpSendEcho2 (_In_ HANDLE IcmpHandle, _In_opt_ HANDLE Event, _In_opt_ FARPROC ApcRoutine, _In_opt_ PVOID ApcContext, _In_ IPAddr DestinationAddress, _In_reads_bytes_(RequestSize) LPVOID RequestData, _In_ WORD RequestSize, _In_opt_ PIP_OPTION_INFORMATION RequestOptions, _Out_writes_bytes_(ReplySize) LPVOID ReplyBuffer, _In_range_(>=, sizeof(ICMP_ECHO_REPLY)+RequestSize+8) DWORD ReplySize, _In_ DWORD Timeout)
IPHLPAPI_DLL_LINKAGE DWORD WINAPI	IcmpSendEcho2Ex (_In_ HANDLE IcmpHandle, _In_opt_ HANDLE Event, _In_opt_ FARPROC ApcRoutine, _In_opt_ PVOID ApcContext, _In_ IPAddr SourceAddress, _In_ IPAddr DestinationAddress, _In_reads_bytes_(RequestSize) LPVOID RequestData, _In_ WORD RequestSize, _In_opt_ PIP_OPTION_INFORMATION RequestOptions, _Out_writes_bytes_(ReplySize) LPVOID ReplyBuffer, _In_range_(>=, sizeof(ICMP_ECHO_REPLY)+RequestSize+8+sizeof(IO_STATUS_BLOCK)) DWORD ReplySize, _In_ DWORD Timeout)
IPHLPAPI_DLL_LINKAGE DWORD WINAPI	Icmp6SendEcho2 (_In_ HANDLE IcmpHandle, _In_opt_ HANDLE Event, _In_opt_ FARPROC ApcRoutine, _In_opt_ PVOID ApcContext, _In_ struct sockaddr_in6 *SourceAddress, _In_ struct sockaddr_in6 *DestinationAddress, _In_reads_bytes_(RequestSize) LPVOID RequestData, _In_ WORD RequestSize, _In_opt_ PIP_OPTION_INFORMATION RequestOptions, _Out_writes_bytes_(ReplySize) LPVOID ReplyBuffer, _In_range_(>=, sizeof(ICMPV6_ECHO_REPLY)+RequestSize+8+sizeof(IO_STATUS_BLOCK)) DWORD ReplySize, _In_ DWORD Timeout)
IPHLPAPI_DLL_LINKAGE DWORD WINAPI	IcmpParseReplies (_Out_writes_bytes_(ReplySize) LPVOID ReplyBuffer, _In_range_(>=, sizeof(ICMP_ECHO_REPLY)+8) DWORD ReplySize)
IPHLPAPI_DLL_LINKAGE DWORD WINAPI	Icmp6ParseReplies (_Out_writes_bytes_(ReplySize) LPVOID ReplyBuffer, _In_range_(>=, sizeof(ICMPV6_ECHO_REPLY)+8) DWORD ReplySize)

Macro Definition Documentation

IPHLPAPI_DLL_LINKAGE

#define IPHLPAPI_DLL_LINKAGE

Definition at line 17 of file icmpapi.h.

Function Documentation

Icmp6CreateFile()

IPHLPAPI_DLL_LINKAGE HANDLE WINAPI Icmp6CreateFile

(

VOID

)

Definition at line 15 of file icmp.c.

{
    HANDLE IcmpFile;
    OBJECT_ATTRIBUTES ObjectAttributes;
    IO_STATUS_BLOCK IoStatusBlock;
    UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\Device\\Ip6");
    NTSTATUS Status;
 
    InitializeObjectAttributes(
        &ObjectAttributes,
        &DeviceName,
        OBJ_CASE_INSENSITIVE,
        NULL,
        NULL);
 
    Status = NtCreateFile(
        &IcmpFile,
        GENERIC_EXECUTE,
        &ObjectAttributes,
        &IoStatusBlock,
        NULL,
        FILE_ATTRIBUTE_NORMAL,
        FILE_SHARE_READ | FILE_SHARE_WRITE,
        FILE_OPEN_IF,
        0,
        NULL,
        0);
 
    if (!NT_SUCCESS(Status))
    {
        SetLastError(RtlNtStatusToDosError(Status));
        return INVALID_HANDLE_VALUE;
    }
 
    return IcmpFile;
}

Icmp6ParseReplies()

IPHLPAPI_DLL_LINKAGE DWORD WINAPI Icmp6ParseReplies	(	_Out_writes_bytes_(ReplySize) LPVOID	ReplyBuffer,
		_In_range_(>=, sizeof(ICMPV6_ECHO_REPLY)+8) DWORD	ReplySize
	)

Icmp6SendEcho2()

IPHLPAPI_DLL_LINKAGE DWORD WINAPI Icmp6SendEcho2	(	_In_ HANDLE	IcmpHandle,
		_In_opt_ HANDLE	Event,
		_In_opt_ FARPROC	ApcRoutine,
		_In_opt_ PVOID	ApcContext,
		_In_ struct sockaddr_in6 *	SourceAddress,
		_In_ struct sockaddr_in6 *	DestinationAddress,
		_In_reads_bytes_(RequestSize) LPVOID	RequestData,
		_In_ WORD	RequestSize,
		_In_opt_ PIP_OPTION_INFORMATION	RequestOptions,
		_Out_writes_bytes_(ReplySize) LPVOID	ReplyBuffer,
		_In_range_(>=, sizeof(ICMPV6_ECHO_REPLY)+RequestSize+8+sizeof(IO_STATUS_BLOCK)) DWORD	ReplySize,
		_In_ DWORD	Timeout
	)

IcmpCloseHandle()

IPHLPAPI_DLL_LINKAGE BOOL WINAPI IcmpCloseHandle

(

_In_ HANDLE

IcmpHandle

)

Definition at line 202 of file icmp.c.

{
    NTSTATUS Status;
 
    Status = NtClose(IcmpHandle);
    if (!NT_SUCCESS(Status))
    {
        SetLastError(RtlNtStatusToDosError(Status));
        return FALSE;
    }
 
    return TRUE;
}

Referenced by RunTraceRoute(), test_Icmp6CreateFile(), test_IcmpCloseHandle(), test_IcmpCreateFile(), test_IcmpSendEcho(), testIcmpSendEcho(), and wmain().

IcmpCreateFile()

IPHLPAPI_DLL_LINKAGE HANDLE WINAPI IcmpCreateFile

(

VOID

)

Definition at line 219 of file icmp.c.

{
    HANDLE IcmpFile;
    OBJECT_ATTRIBUTES ObjectAttributes;
    IO_STATUS_BLOCK IoStatusBlock;
    UNICODE_STRING DeviceName = RTL_CONSTANT_STRING(L"\\Device\\Ip");
    NTSTATUS Status;
 
    InitializeObjectAttributes(
        &ObjectAttributes,
        &DeviceName,
        OBJ_CASE_INSENSITIVE,
        NULL,
        NULL);
 
    Status = NtCreateFile(
        &IcmpFile,
        GENERIC_EXECUTE,
        &ObjectAttributes,
        &IoStatusBlock,
        NULL,
        FILE_ATTRIBUTE_NORMAL,
        FILE_SHARE_READ | FILE_SHARE_WRITE,
        FILE_OPEN_IF,
        0,
        NULL,
        0);
 
    if (!NT_SUCCESS(Status))
    {
        SetLastError(RtlNtStatusToDosError(Status));
        return INVALID_HANDLE_VALUE;
    }
 
    return IcmpFile;
}

IcmpParseReplies()

IPHLPAPI_DLL_LINKAGE DWORD WINAPI IcmpParseReplies	(	_Out_writes_bytes_(ReplySize) LPVOID	ReplyBuffer,
		_In_range_(>=, sizeof(ICMP_ECHO_REPLY)+8) DWORD	ReplySize
	)

IcmpSendEcho()

IPHLPAPI_DLL_LINKAGE DWORD WINAPI IcmpSendEcho	(	_In_ HANDLE	IcmpHandle,
		_In_ IPAddr	DestinationAddress,
		_In_reads_bytes_(RequestSize) LPVOID	RequestData,
		_In_ WORD	RequestSize,
		_In_opt_ PIP_OPTION_INFORMATION	RequestOptions,
		_Out_writes_bytes_(ReplySize) LPVOID	ReplyBuffer,
		_In_range_(>=, sizeof(ICMP_ECHO_REPLY)+RequestSize+8) DWORD	ReplySize,
		_In_ DWORD	Timeout
	)

IcmpSendEcho2()

IPHLPAPI_DLL_LINKAGE DWORD WINAPI IcmpSendEcho2	(	_In_ HANDLE	IcmpHandle,
		_In_opt_ HANDLE	Event,
		_In_opt_ FARPROC	ApcRoutine,
		_In_opt_ PVOID	ApcContext,
		_In_ IPAddr	DestinationAddress,
		_In_reads_bytes_(RequestSize) LPVOID	RequestData,
		_In_ WORD	RequestSize,
		_In_opt_ PIP_OPTION_INFORMATION	RequestOptions,
		_Out_writes_bytes_(ReplySize) LPVOID	ReplyBuffer,
		_In_range_(>=, sizeof(ICMP_ECHO_REPLY)+RequestSize+8) DWORD	ReplySize,
		_In_ DWORD	Timeout
	)

IcmpSendEcho2Ex()

IPHLPAPI_DLL_LINKAGE DWORD WINAPI IcmpSendEcho2Ex	(	_In_ HANDLE	IcmpHandle,
		_In_opt_ HANDLE	Event,
		_In_opt_ FARPROC	ApcRoutine,
		_In_opt_ PVOID	ApcContext,
		_In_ IPAddr	SourceAddress,
		_In_ IPAddr	DestinationAddress,
		_In_reads_bytes_(RequestSize) LPVOID	RequestData,
		_In_ WORD	RequestSize,
		_In_opt_ PIP_OPTION_INFORMATION	RequestOptions,
		_Out_writes_bytes_(ReplySize) LPVOID	ReplyBuffer,
		_In_range_(>=, sizeof(ICMP_ECHO_REPLY)+RequestSize+8+sizeof(IO_STATUS_BLOCK)) DWORD	ReplySize,
		_In_ DWORD	Timeout
	)