GetClient Method

Applies To

OSession

Description

This method returns the associated client object by way of an OClient handle.

Usage

OClient GetClient(void) const

Remarks

Given an OSession, you can obtain an OClient object, which you can then use to access the client object. Note that this does not create another client object; rather it returns another OClient that is a handle for an already existing client object.

Return Value

An OClient, which will be open on success, closed on failure.

Example

This example gets a list of the sessions on the workstation.

// construct and open an OSession on the default session

OSession defsess(0);

// get the client object

OClient theclient = defsess.GetClient();

// now get the list of sessions

OSessionCollection sessset = theclient.GetSessions();