The xAssets API - Method : SpecialLogoffUser

Summary

Forcibly log one or more users off, thus freeing connections when the concurrent user licensing model is deployed

Parameters

Parameter : sXML

Parameter : sArguments

0
A comma separated list of User names

Returns

An empty string. If an error occurs, an error message will be returned

Syntax and Examples

Restful syntax with Microsoft Visual Basic

Example 1 - Logoff users DEV\Administrator and x@y.com

There is no restful call for this API operation - use a SOAP method instead

SOAP Syntax with Microsoft Visual Basic

Example 1 - Logoff users DEV\Administrator and x@y.com


    Try

        ErrorMessage = ""

        Return w.WebSaveSpecial(_hash, _username, _db, _ip, "", "SpecialLogoffUser", {"DEV\Administrator,x@y.com"}, False, _dns, _port, _scheme, _nonce, _noncedate)

    Catch ex As Exception
        ErrorMessage = ex.Message
        Return "
    End Try

                            

AMSX Syntax

Example 1 - Logoff users DEV\Administrator and x@y.com


    SaveSpecial "SpecialLogoffUser","", "DEV\Administrator,x@y.com"
                        

XCS Syntax

Example 1 - Logoff users DEV\Administrator and x@y.com


    Dim ret as String = Server.SaveSpecial("SpecialLogoffUser","", "DEV\Administrator,x@y.com")
    If ret = " Or ret.Substring(0, 8) = "special=" Then
        MsgBox("Save operation completed.", vbInformation, "Save Data")
    Else
        MsgBox("Save operation failed:" & ret, vbExclamation, "Save Data")
    End If
                        

Download the Visual Studio API Samples Project

Return to the API Index Page