WinWaitMuxWaitSem - Parameters

hmux (HMUX) - input

The handle of the muxwait semaphore to wait for.

ulTimeout (ULONG) - input

Time-out in milliseconds.

This is the maximum amount of time the user wants to allow the thread to be blocked.

This parameter can also have the following values:

SEM_IMMEDIATE_RETURN (0)

WinWaitMuxWaitSem returns without blocking the calling thread.
SEM_INDEFINITE_WAIT (-1)
WinWaitMuxWaitSem blocks the calling thread indefinitely.

pulUser (PULONG) - output

Pointer to receive the user field.

A pointer to receive the user field (from the muxwait semaphore data structure) of the semaphore that was posted or released.

If DCMW_WAIT_ANY was specified in the flAttr parameter when the muxwait semaphore was created, this will be the user field of the semaphore that was posted or released. If the muxwait semaphore consists of mutex semaphores, any mutex semaphore that is released is owned by the caller.

If DCMW_WAIT_ALL was specified in the flAttr parameter when the muxwait semaphore was created, this will be the user field of the last semaphore that was posted or released. (If the thread did not block, the last semaphore that was posted or released will also be the last semaphore in the muxwait-semaphore list.) If the muxwait semaphore consists of mutex semaphores, all of the mutex semaphores that are released are owned by the caller.

ulrc (APIRET) - returns

Return Code.

WinWaitMuxWaitSem returns the following values:

• NO_ERROR 6
  ERROR_INVALID_HANDLE
  8
  ERROR_NOT_ENOUGH_MEMORY
  87
  ERROR_INVALID_PARAMETER
  95
  ERROR_INTERRUPT
  103
  ERROR_TOO_MANY_SEM_REQUESTS
  105
  ERROR_SEM_OWNER_DIED
  286
  ERROR_EMPTY_MUXWAIT
  287
  ERROR_MUTEX_OWNED
  292
  ERROR_WRONG_TYPE
  640
  ERROR_TIMEOUT

  ---

  [Back: WinWaitMuxWaitSem Return Value - ulrc]
  [Next: WinWaitMuxWaitSem - Remarks]