xSession Class

Gets information about Microsoft Dynamics AX sessions.

Syntax

class xSession extends Object

Run On

Called

Methods

	Method	Description
	AOSName	Retrieves the name of the Application Object Server (AOS) that is responsible for servicing the session.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	clientComputerName	Retrieves the network name of the client computer that is responsible for servicing the session.
	clientKind	Retrieves the type of the client that is responsible for servicing the session.
	databaseSpid	Retrieves a comma-separated list of active connection IDs.
	documentationLanguage	Retrieves the language ID of the documentation that is shown for the session.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	interfaceLanguage	Retrieves the ID for the language that is used on menus and dialogs for the session.
	isWorkerThread	Determines whether the session is a worker thread.
	loginDate	Retrieves the date on which the user of the session logged on.
	loginDateTime
	loginTime	Retrieves the time at which the user of the session logged on.
	masterSessionId	Retrieves the master session ID for the session that the xSession object covers.
	new	Instantiates the xSession object, either for current session or for the session ID passed in as a parameter. (Overrides the new Method.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	serverId
	sessionId	Retrieves the session ID of the session that the xSession object covers.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	terminate	Terminates the session ID that the object was instantiated with.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	userId	Retrieves the user ID that this session is logged on with.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::clientSetAutoUpdateRecVersion
	::currentRetryCount	Counts the number of times a try block has been retried after a deadlock, an update conflict, or another exception.
	::currentUnCheck
	::getDbSchema	Retrieves the schema part of the database object name for the session.
	::getIISObject	Instantiates and returns a COM object for an IIS object.
	::getSysTraceActive	Enables you to determine whether system tracing is turned on for the session.
	::getXRefAssembyTempFolder
	::isCLRSession
	::isUserPreferredTzSameAsLocalMachine
	::lastDuplicateKeyViolatingTable
	::lastUpdateConflictingTable	Retrieves an instance of the table that most recently had an update conflict.
	::maxSessionId	Retrieves the maximum number of sessions that are permitted by the current license codes.
	::numSession	Retrieves the current number of registered sessions.
	::pseudoBandwidth	Determines whether bandwidth simulation is turned on for the session, and enables bandwidth simulation to be turned on or off.
	::pseudoLatency	Determines whether latency simulation is turned on for the session, and enables latency simulation to be turned on or off.
	::pseudoSimMode	Determines whether delay simulation is turned on for the session, and enables delay simulation to be turned on or off.
	::reloadTableCollectionOnClient
	::removeAOC	Removes the Application Object Server client-side cache (AOC) for the current session.
	::serverSetAutoUpdateRecVersion
	::setAutoUpdateRecVersion
	::setSysTraceActive	Switches system tracing on or off.
	::systemSessionId	Retrieves the system session ID for the session that the xSession object covers.
	::updateAOC	Updates the Application Object Server client-side cache (AOC) for the current session.
	::xppCallStack	Retrieves the current call stack.

Top

Remarks

To get information about the current session, create a new xSession session without parameters. The only way to get information about all active sessions (AOS only) is to traverse from session ID 1 to xSession.maxSessionId. The IDs are not an unbroken list, but will never exceed the maximum number of sessions as specified in the maxSessionId method.

Examples

The following example creates a new xSession object, and then uses it to find the name of the server for the current session.

xSession xSession; 
 
xSession = new xSession();   
// Prints the name of server for the current session. 
print xSession.AOSName();

Inheritance Hierarchy

Object Class
  xSession Class
    Session Class