NdisOpenFile - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// ndis.h
VOID NdisOpenFile(
[out] PNDIS_STATUS Status,
[out] PNDIS_HANDLE FileHandle,
[out] PUINT FileLength,
[in] PNDIS_STRING FileName,
[in] NDIS_PHYSICAL_ADDRESS HighestAcceptableAddress
);
View the official Windows Driver Kit DDI referenceNo description available.
The NdisOpenFile function returns a handle for an opened file.
Status [out]A pointer to a caller-supplied variable in which this function returns the status of the open file operation, which can be one of the following:
The handle at FileHandle is valid for a subsequent call to NdisMapFile.
The given string at FileName did not specify a name found in the system object namespace.
NDIS could not allocate the resources it needed to open the file and allocate a buffer for the file contents.
The specified file's data could not be read into system memory for subsequent access by the caller.
FileHandle [out]A pointer to a caller-supplied variable in which this function returns the handle of the opened file if the call succeeds.
FileLength [out]A pointer to a caller-supplied variable in which this function writes the number of bytes of data in the opened file if the call succeeds.
FileName [in]A pointer to an NDIS_STRING type containing an initialized counted string, in the system-default character set, naming the file to be opened. For Windows 2000 and later drivers, this string contains Unicode characters. That is, for Windows 2000 and later, NDIS defines the NDIS_STRING type as a UNICODE_STRING type.
HighestAcceptableAddress [in]The highest physical address in which the file data can be stored, or specifies -1 if the driver places no restrictions.
NdisOpenFile opens a disk file, typically a file the driver will later download to program an intelligent NIC. NdisOpenFile also allocates storage to hold file contents for the driver's subsequent call to the NdisMapFile function.
A miniport driver should call NdisOpenFile only from the MiniportInitializeEx function.
When NdisOpenFile returns, the miniport driver can access file data by calling NdisMapFile. It can call the NdisUnmapFile function to page out the file so it does not consume resources unnecessarily while the driver is not accessing the file data. When finished using the file, MiniportInitializeEx must call the NdisCloseFile function.
[!NOTE] NdisOpenFile, NdisCloseFile, NdisMapFile and NdisUnmapFile are not supported on ARM64. On ARM64, replace these functions with calls to ZwCreateFile, ZwReadFile, or other similar operations.