NDIS_INIT_MUTEX (Compact 2013)

  • Article

3/26/2014

This macro initializes a mutex object and sets it to a signaled state.

Syntax

NDIS_INIT_MUTEX(_Mutex_)

Parameters

  • _Mutex_
    A pointer to a caller-supplied NDIS_MUTEX-type mutex object. NDIS_MUTEX is a wrapper for KMUTEX.

Return Value

None

Remarks

NDIS network drivers should use the NDIS_INIT_MUTEX macro to initialize a mutex.

The initial state of the mutex object is the signaled state. To obtain the mutex, call the NDIS_WAIT_FOR_MUTEX macro. To release the mutex, call the NDIS_RELEASE_MUTEX macro.

A driver cannot wait for a nonzero time interval on a mutex object at a raised IRQL or in an arbitrary thread context (that is, the context of whatever thread is current when a driver function is called).

Storage for a mutex object must reside in a driver context area or in a nonpaged pool that the caller allocated.

The NDIS_INIT_MUTEX macro is an NDIS wrapper for the KeInitializeMutex routine.

Requirements

Header

ndis.h

See Also

Reference

NDIS Interrupt and Synchronization Macros
NDIS_RELEASE_MUTEX
NDIS_WAIT_FOR_MUTEX