UserLoggedOut method

Event

A user logged out of VWorks software.

Description

VWorks software calls the UserLoggedOut method after a user logs out of VWorks software.

Syntax

 

HRESULT UserLoggedOut( [in] BSTR sXML, [in, out] BSTR* sResultXML );

Parameters

 

sXML	[in] A LogoutComplete XML element that contains the name of the user who logged out of VWorks software.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

UserLoggedOut method input

VWorks software passes a LogoutComplete XML element into the sXML parameter of the UserLoggedOut method. This XML element provides the name of the user who logged out of VWorks software.

LogoutComplete element

The LogoutComplete element has the following attribute:

 

Name	Value
UserName	The name of the user.

Example of UserLoggedOut method input

The following sample code is a LogoutComplete XML element that is received from VWorks software by the plugin as a string in the sXML parameter of the UserLoggedOut method. VWorks software tells the plugin that the user named LSinclair logged out of VWorks software.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='07d1a5a4cb08ef463f3213a90a7261e4' version='1.0' > <LogoutComplete UserName='LSinclair' /> </Velocity11>

UserLoggedOut method output

The plugin returns a HookResults XML block in the sResultXML parameter of the UserLoggedOut method. For information about the structure and contents of this XML block, see “HookResults XML block” .

Example of UserLoggedOut method output

The following sample code is a HookResults XML block that is returned to VWorks software by the plugin as a string in the sResultXML parameter of the UserLoggedOut method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

LSinclair logged out.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' ResultValue='LSinclair logged out.' /> </Results> </HookResults> </Velocity11>

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”