wpWaitForClose - Parameters

somSelf (WPObject *) - input

Pointer to the object on which the method is being invoked.

Points to an object of class WPObject.

lhView (LHANDLE) - input

Handle (hwnd or happ) of the view that must close before the application can continue.

If a value of NULL is passed, this method waits for all views of the specified type (ulViews) to close.

ulViews (ULONG) - input

Type of views to wait for.

This value is only used if lhView is NULL.

ulTimeOut (ULONG) - input

Time to wait for the views to close.

Timeout 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

Returns immediately without blocking the calling thread.
SEM_INDEFINITE_WAIT
Blocks the calling thread indefinitely.

bAutoClose (BOOL) - input

Flag indicating whether to automatically close.

This parameter should not be used as the standard method to close views. It exists ONLY to handle the possibility of a timing hole where all of the specified views are closed and another thread (probably due to user input) opens another view of the same type before wpWaitForClose returns.

Possible values are described in the following list:

TRUE

WM_Close is posted for the views that are not presently closing, or WinTerminateApp is called on the applications that are being waited on.
FALSE
Views that are not presently closing are not automatically closed.

Success (ULONG) - returns

Return value from WinWaitEventSem function.

This parameter can also have the following values:

• The view was closed successfully or was already closed when this method processed. -1
  Error occurred.

  ---

  [Back: wpWaitForClose Return Value - Success]
  [Next: wpWaitForClose - Remarks]