devutils.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	FILE_SHARE_ALL    (FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE)

Functions
NTSTATUS	pOpenDeviceEx_UStr (_In_ PCUNICODE_STRING DevicePath, _Out_ PHANDLE DeviceHandle, _In_ ACCESS_MASK DesiredAccess, _In_ ULONG ShareAccess)
	Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is for synchronous I/O access.
NTSTATUS	pOpenDevice_UStr (_In_ PCUNICODE_STRING DevicePath, _Out_ PHANDLE DeviceHandle)
	Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is share read/write/delete, for synchronous I/O and read access.
NTSTATUS	pOpenDeviceEx (_In_ PCWSTR DevicePath, _Out_ PHANDLE DeviceHandle, _In_ ACCESS_MASK DesiredAccess, _In_ ULONG ShareAccess)
	Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is for synchronous I/O access.
NTSTATUS	pOpenDevice (_In_ PCWSTR DevicePath, _Out_ PHANDLE DeviceHandle)
	Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is share read/write/delete, for synchronous I/O and read access.

Macro Definition Documentation

FILE_SHARE_ALL

#define FILE_SHARE_ALL    (FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE)

Definition at line 12 of file devutils.h.

Function Documentation

pOpenDevice()

NTSTATUS pOpenDevice	(	_In_ PCWSTR	DevicePath,
		_Out_ PHANDLE	DeviceHandle
	)

Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is share read/write/delete, for synchronous I/O and read access.

Parameters

[in]	DevicePath
[out]	DeviceHandle	See the DevicePath and DeviceHandle parameters of pOpenDeviceEx_UStr().

Returns

An NTSTATUS code indicating success or failure.

See also

pOpenDeviceEx(), pOpenDevice_UStr(), pOpenDeviceEx_UStr()

Definition at line 128 of file devutils.c.

{
    UNICODE_STRING Name;
    RtlInitUnicodeString(&Name, DevicePath);
    return pOpenDevice_UStr(&Name, DeviceHandle);
}

Referenced by MountVolume().

pOpenDevice_UStr()

NTSTATUS pOpenDevice_UStr	(	_In_ PCUNICODE_STRING	DevicePath,
		_Out_ PHANDLE	DeviceHandle
	)

Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is share read/write/delete, for synchronous I/O and read access.

Parameters

[in]	DevicePath
[out]	DeviceHandle	See the DevicePath and DeviceHandle parameters of pOpenDeviceEx_UStr().

Returns

An NTSTATUS code indicating success or failure.

See also

pOpenDevice(), pOpenDeviceEx(), pOpenDeviceEx_UStr()

Definition at line 76 of file devutils.c.

{
    return pOpenDeviceEx_UStr(DevicePath,
                              DeviceHandle,
                              FILE_READ_DATA | FILE_READ_ATTRIBUTES,
                              FILE_SHARE_ALL);
}

Referenced by pOpenDevice().

pOpenDeviceEx()

NTSTATUS pOpenDeviceEx	(	_In_ PCWSTR	DevicePath,
		_Out_ PHANDLE	DeviceHandle,
		_In_ ACCESS_MASK	DesiredAccess,
		_In_ ULONG	ShareAccess
	)

Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is for synchronous I/O access.

Parameters

[in]	DevicePath
[out]	DeviceHandle
[in]	DesiredAccess
[in]	ShareAccess	See pOpenDeviceEx_UStr() parameters.

Returns

An NTSTATUS code indicating success or failure.

See also

pOpenDeviceEx_UStr()

Definition at line 102 of file devutils.c.

{
    UNICODE_STRING Name;
    RtlInitUnicodeString(&Name, DevicePath);
    return pOpenDeviceEx_UStr(&Name, DeviceHandle, DesiredAccess, ShareAccess);
}

Referenced by DismountVolume().

pOpenDeviceEx_UStr()

NTSTATUS pOpenDeviceEx_UStr	(	_In_ PCUNICODE_STRING	DevicePath,
		_Out_ PHANDLE	DeviceHandle,
		_In_ ACCESS_MASK	DesiredAccess,
		_In_ ULONG	ShareAccess
	)

Open an existing device given by its NT-style path, which is assumed to be for a disk device or a partition. The open is for synchronous I/O access.

Parameters

[in]	DevicePath	Supplies the NT-style path to the device to open.
[out]	DeviceHandle	If successful, receives the NT handle of the opened device. Once the handle is no longer in use, call NtClose() to close it.
[in]	DesiredAccess	An ACCESS_MASK value combination that determines the requested access to the device. Because the open is for synchronous access, SYNCHRONIZE is automatically added to the access mask.
[in]	ShareAccess	Specifies the type of share access for the device.

Returns

An NTSTATUS code indicating success or failure.

See also

pOpenDeviceEx()

Definition at line 38 of file devutils.c.

{
    OBJECT_ATTRIBUTES ObjectAttributes;
    IO_STATUS_BLOCK IoStatusBlock;
 
    InitializeObjectAttributes(&ObjectAttributes,
                               (PUNICODE_STRING)DevicePath,
                               OBJ_CASE_INSENSITIVE,
                               NULL,
                               NULL);
    return NtOpenFile(DeviceHandle,
                      DesiredAccess | SYNCHRONIZE,
                      &ObjectAttributes,
                      &IoStatusBlock,
                      ShareAccess,
                      /* FILE_NON_DIRECTORY_FILE | */
                      FILE_SYNCHRONOUS_IO_NONALERT);
}

Referenced by GetDeviceInfo_UStr(), InstallBootManagerAndBootEntries(), pOpenDevice_UStr(), and pOpenDeviceEx().