xSession Class

Definition

Gets information about Finance and Operations sessions.

public ref class xSession : Microsoft::Dynamics::Ax::Xpp::XppObjectBase
[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class xSession : Microsoft.Dynamics.Ax.Xpp.XppObjectBase
[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type xSession = class
    inherit XppObjectBase
Public Class xSession
Inherits XppObjectBase
Inheritance
Microsoft.Dynamics.AX.KernelInterop.ProxyBase
xSession
Attributes

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.

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();

Constructors

xSession()
xSession(Int32)
xSession(Int32, Boolean)
xSession(IntPtr)

Fields

kernelClass (Inherited from XppObjectBase)

Methods

__shouldCallNew(Type)
abort()
abortChildSessions()
addXppProxyReference(Type, Object) (Inherited from XppObjectBase)
AOSName()

Retrieves the name of the Application Object Server (AOS) that is responsible for servicing the session.

Call(String, Object[], Type[], Object[]) (Inherited from XppObjectBase)
cancelTimeOut(Int32) (Inherited from XppObjectBase)
clientComputerName()

Retrieves the network name of the client computer that is responsible for servicing the session.

clientKind()
Obsolete.

Retrieves the type of the client that is responsible for servicing the session.

createKernelClass(Object[], Type[], Object[]) (Inherited from XppObjectBase)
currentRetryCount()

Counts the number of times a try block has been retried after a deadlock, an update conflict, or another exception.

currentUnCheck()
databaseSpid()

Retrieves a comma-separated list of active connection IDs.

disableDeploymentRoleEmulation()
documentationLanguage()

Retrieves the language ID of the documentation that is shown for the session.

enableDeploymentDataAreaId(String)
enableDeploymentRoleEmulation(Int32)
equal(XppObjectBase) (Inherited from XppObjectBase)
finalize() (Inherited from XppObjectBase)
getAADClientApplicationId()
getCurrentUserExternalId()
getCurrentUserGuid()
getDbSchema()

Retrieves the schema part of the database object name for the session.

getIISObject(IISObject)

Instantiates and returns a COM object for an IIS object.

GetIntPtr()
GetKernelInstanceUniqueId() (Inherited from XppObjectBase)
getSysTraceActive()

Enables you to determine whether system tracing is turned on for the session.

getTimeOutTimerHandle() (Inherited from XppObjectBase)
getUserGuid(String)
getXppProxyReference(Type) (Inherited from XppObjectBase)
getXRefAssembyTempFolder()
handle()
interfaceLanguage()

Retrieves the ID for the language that is used on menus and dialogs for the session.

isAborted()
isCLRSession()
IsManagedValid()
isUserPreferredTzSameAsLocalMachine()
isWorkerThread()

Determines whether the session is a worker thread.

kernelhandle()
KernelInstanceDisposed() (Inherited from XppObjectBase)
lastDuplicateKeyViolatingTable()
lastUpdateConflictingTable()

Retrieves an instance of the table that most recently had an update conflict.

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.

MakeReflectionCall(String, Object[]) (Inherited from XppObjectBase)
masterSessionId()

Retrieves the master session ID for the session that the xSession object covers.

maxSessionId()

Retrieves the maximum number of sessions that are permitted by the current license codes.

newmethod()

Instantiates the xSession object, either for current session or for the session ID passed in as a parameter.

newmethod(Int32)
newmethod(Int32, Boolean)
notify() (Inherited from XppObjectBase)
notifyAll() (Inherited from XppObjectBase)
notifyScaleUnitSettingsChanged()
numSession()

Retrieves the current number of registered sessions.

objectOnServer()
Obsolete.
(Inherited from XppObjectBase)
preferredLocale()
pseudoBandwidth()

Determines whether bandwidth simulation is turned on for the session, and enables bandwidth simulation to be turned on or off.

pseudoBandwidth(Int32)
pseudoLatency()

Determines whether latency simulation is turned on for the session, and enables latency simulation to be turned on or off.

pseudoLatency(Int32)
pseudoSimMode()

Determines whether delay simulation is turned on for the session, and enables delay simulation to be turned on or off.

pseudoSimMode(Int32)
reloadTableCollectionOnClient()
removeAOC()

Removes the Application Object Server client-side cache (AOC) for the current session.

serverId()
sessionId()

Retrieves the session ID of the session that the xSession object covers.

setAutoUpdateRecVersion(Boolean)
setSysTraceActive(Boolean)

Switches system tracing on or off.

setTimeOut(String, Int32)
Obsolete.
(Inherited from XppObjectBase)
setTimeOut(String, Int32, Boolean)
Obsolete.
(Inherited from XppObjectBase)
systemSessionId()

Retrieves the system session ID for the session that the xSession object covers.

terminate()

Terminates the session ID that the object was instantiated with.

terminate(Date)
terminate(Date, Int32)
updateAOC()

Updates the Application Object Server client-side cache (AOC) for the current session.

usageCount() (Inherited from XppObjectBase)
userId()

Retrieves the user ID that this session is logged on with.

VerifyKernelClass() (Inherited from XppObjectBase)
wait() (Inherited from XppObjectBase)
Xml() (Inherited from XppObjectBase)
Xml(Int32) (Inherited from XppObjectBase)
xppCallStack()

Retrieves the current call stack.

Applies to