GetSession function
Syntax
GetSession()
Description
Use the GetSession function to retrieve a PeopleSoft session object.
After you use GetSession, you can instantiate many other types of objects, like Component Interfaces, data trees, and so on.
After you use GetSession you must connect to the system using the Connect property.
If you are connecting to the existing session and not doing additional error checking, you may want to use the %Session system variable instead of GetSession. %Session returns a connection to the existing session.
Parameters
None.
Returns
A PeopleSoft session object.
Example
Local ApiObject &MYSESSION;
&MYSESSION = GetSession();
Related Topics
- PeopleCode API Reference: Understanding Component Interface Class
- PeopleCode API Reference: Understanding the Portal Registry
- PeopleCode API Reference: Understanding Query Classes
- PeopleCode API Reference: Understanding Session Class
- PeopleCode API Reference: Understanding Tree Classes
- %Session system variable