DosSelectSession

From EDM2
Jump to: navigation, search

DosSelectSession lets a parent session switch one of its child sessions or itself to the foreground, no grandchild session or any other descendant beyond a child session can be selected.

Syntax

DosSelectSession ( ulIDSession )

Parameters

ulIDSession (ULONG) - input
The ID of the session to be switched to the foreground.

Returns

rc (APIRET) - return
0 NO_ERROR
224 ERROR_SMG_NO_TARGET_WINDOW
369 ERROR_SMG_INVALID_SESSION_ID
418 ERROR_SMG_INVALID_CALL
459 ERROR_SMG_BAD_RESERVE
460 ERROR_SMG_PROCESS_NOT_PARENT
463 ERROR_SMG_RETRY_SUB_ALLOC

Usage Explanation

The child process will not be brought to the foreground unless the parent session or one of its descendant sessions is currently executing in the foreground. For windowed applications is the application that owns the window focus the foreground session. It is only possible to issue DosSelectSession on sessions started by the current session with DosStartSession, with Related set to SSF_RELATED_CHILD (=1).

Sample Code

#define INCL_DOSSESMGR
#include <os2.h>

ULONG ulIDSession; 

/* Start a child session with DosStartSession */
/* psd->Related=SSF_RELATED_CHILD; */
/* DosStartSession(psd,&ulIDSession,..); */ 

if(DosSelectSession(ulIDSession)) /* Switch child session to foreground */
{
    /* Problems */
}
else
{
    /* The child session is now in the foreground */
}

See Also