Share via

STOPSESSION Function (Sessions)

  • Article

Stops a Dynamics NAV session.

Syntax

[OK :=] STOPSESSION(SessionID[,Comment]);

Parameters

SessionID
Type: Integer

The ID of the session that you want to stop.

The session can be any of the following:

  • Microsoft Dynamics NAV Windows client session

  • Microsoft Dynamics NAV Web client session

  • NAS services session

  • SOAP web services client session

  • OData web services client session

  • Background session

    Comment
    Type: Text

    An optional comment about the session event. The comment is stored in Table 2000000111, the Session Event table.

Property Value/Return Value

Type: Boolean

true if the session is stopped successfully and no errors occurred; otherwise false.

If you omit this optional return value and the session is not stopped successfully, then a run-time error occurs. If you include the return value, then you must handle any errors.

Remarks

The session that you want to stop and the session that calls STOPSESSION must be running on the same instance of Microsoft Dynamics NAV Server. The session is stopped before the next C/AL statement executes. Open transactions are rolled back.

If the current executing statement is the SLEEP function, then the session is stopped immediately.

When a session is executing C/AL that does not interact with the server connection or the access lock used by the connection, STOPSESSION cannot terminate the connection. STOPSESSION can terminate connections that are inactive, idle, or using the database but not blocked.

Note

In the Microsoft Dynamics NAV Windows client, STOPSESSION cannot be used to stop the session in which it is called. In this case, the STOPSESSION call is ignored, and returns false.

Example

This example requires that you create the following variables, and assumes that you have a table named CacheStressTest that you use for testing.

Variable name DataType Subtype
SessionId Integer Not applicable
CacheStressTestRec Record CacheStressTest 
STARTSESSION(SessionId, CODEUNIT::"Cache Stress Test", COMPANYNAME, CacheStressTestRec);  
STOPSESSION(SessionId, 'Logoff cache stress test session');