OpenEdge ABL API Reference

Ccs.Common.IClientContext

Save PDF

Ccs.Common.IClientContext

Save PDF

Last Updated: January 15, 2026
2 minute read

OpenEdge
Version 12.8
Documentation

Namespace:	Ccs.Common
Type: Interface	IClientContext
Parent Classes:
Inherits:	Progress.Lang.Object

	This Software is licensed by Progress Software Corporation (licensor)
	under the Progress Software Common Component Specification Project
	Release License Agreement available at
	https://community.progress.com/products/directions/common_component/p/releaselicenseagreement
	The Interface definition is part of the Common Component Specification [CCSBE01]. The
	file is considered as a Specification Implementation Condition as described
	in section 2.1.1.1: If Licensor has made Specification Implementation
	Conditions available as of the date Licensee completes its Independent
	Implementation, then Licensee must, prior to making any claim that its
	Independent Implementation complies with the Specification, ensure that
	the Independent Implementation satisfies all of the Specification
	Implementation Conditions. If Licensor subsequently makes available or
	updates, from time to time, the Specification Implementation Conditions,
	then Licensee will verify that its Independent Implementation satisfies the
	latest version of the Specification Implementation Conditions within ninety
	(90) days following Licensor's release thereof.
	Contributors:
	Peter Judge, Progress Software Corp [2017]
File:	IClientContext
Purpose:	Session Management Client Context interface
Author(s):	pjudge@progress.com
Created:	2017-03-02
Notes:	* The Client Context object represents the client context data for the client making the request.
	The current Client Context object is instantiated and made available by the Session Manager.
	The Session Manager must allow for the application to supply the implementation of the Ccs.Common.IClientContext interface
	/* A unique ID for the Client Context object.

Method Summary

	Options	Name	Purpose
		initializeContext (character)	/* Initialize the context data for the Client Context object @param character The known Session ID for the client request @throws Progress.Lang.SysError, Progress.Lang.AppError */
		initializeContext (handle)	/* Initialize the context data for the Client Context object @param handle The handle to the Client Principal object for the client request @throws Progress.Lang.SysError, Progress.Lang.AppError */
		saveContext ()	/* Save the context data to a persistent store @throws Progress.Lang.SysError, Progress.Lang.AppError */

Property Summary

	Options	Name	Purpose
		HANDLE clientPrincipal
		CHARACTER contextID

Method Detail

Top

initializeContext (character)

	/* Initialize the context data for the Client Context object
	@throws Progress.Lang.SysError, Progress.Lang.AppError

Parameters:
pcSessionID	CHARACTER

Top

initializeContext (handle)

	/* Initialize the context data for the Client Context object
	@throws Progress.Lang.SysError, Progress.Lang.AppError

Parameters:
phClientPrincipal	HANDLE

Top

saveContext ()

	/* Save the context data to a persistent store
	@throws Progress.Lang.SysError, Progress.Lang.AppError

Property Detail

Top

HANDLE clientPrincipal

Returns	HANDLE

Top

CHARACTER contextID

Returns	CHARACTER