NdisMCreateLog (Windows Embedded CE 6.0)

1/6/2010

This function allocates and opens a log file in which a NIC miniport can write data to be displayed by a driver-dedicated Microsoft® Win32® application.

Syntax

            NDIS_STATUS NdisMCreateLog(
            NDIS_HANDLE
            MiniportAdapterHandle
            ,
            UINT
            Size
            ,
            PNDIS_HANDLE
            LogHandle
            );
        

Parameters

• MiniportAdapterHandle
  [in] Specifies the handle input to MiniportInitialize.

• Size
  [in] Specifies how many bytes to allocate for the log file. NDIS creates a temporary file that is not stored on disk.

• LogHandle
  [out] Points to a caller-supplied variable in which this function returns a handle to the log file. This handle is a required parameter to the NdisXXXLog functions that the miniport calls subsequently.

Return Value

The following table shows the return values for this function.

Remarks

A NIC miniport can call the NdisMXXXLog functions to provide any information the driver writer chooses. Whatever the miniport logs can be displayed by a driver-dedicated Win32 application. Such an application calls the Win32 function DeviceIoControl with IOCTL_NDIS_GET_LOG_DATA periodically to retrieve whatever the miniport has written to the log file. For example, an under-development miniport might write test data to be displayed by its corresponding application.

If NdisMCreateLog returns NDIS_STATUS_RESOURCES, the driver can adjust the original Size down and try calling this function again. However, a miniport cannot call NdisMCreateLog to create more than one log file after a call succeeds.

Whatever size of log file is allocated, subsequent calls to NdisMWriteLogData store data in this file, which is treated as a circular buffer. That is, a sequence of calls to NdisMWriteLogData eventually overwrites the data originally written to the log file.

Requirements

See Also

Reference

NDIS Library Functions
MiniportInitialize
NdisMCloseLog
NdisMFlushLog
NdisMWriteLogData