Called when the Task server connects to a vault.

Namespace: BlueCieloECM.InnoCielo.Meridian.Server
Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 1.4.0.0 (1.4.40.0)

Syntax

C#
protected virtual bool OnConnect(
	ref string machineName,
	ref string vaultOrDataStoreName,
	ref string workAreaID,
	ref string userName,
	out string password
)
Visual Basic
Protected Overridable Function OnConnect ( _
	ByRef machineName As String, _
	ByRef vaultOrDataStoreName As String, _
	ByRef workAreaID As String, _
	ByRef userName As String, _
	<OutAttribute> ByRef password As String _
) As Boolean
Visual C++
protected:
virtual bool OnConnect(
	String^% machineName, 
	String^% vaultOrDataStoreName, 
	String^% workAreaID, 
	String^% userName, 
	[OutAttribute] String^% password
)

Parameters

machineName
Type: System..::..String%
The name of the server machine. If nullNothingnullptra null reference (Nothing in Visual Basic) or an empty string, then a local machine is used.
vaultOrDataStoreName
Type: System..::..String%
The name of the vault or data store. If nullNothingnullptra null reference (Nothing in Visual Basic) or an empty string, then the default vault will be opened.
workAreaID
Type: System..::..String%
The ID property value of a work area in the vault. If nullNothingnullptra null reference (Nothing in Visual Basic) or an empty string, then the vault will be opened in the context of the main area.
userName
Type: System..::..String%
On input, the name of the user who submitted the task. On output, the name of the user account that will be used to connect to the vault.
password
Type: System..::..String%
The password for the user account that will be used to connect to the vault.

Return Value

A value indicating whether the access to a vault is required.

Remarks

If access to a vault is required, return trueTruetruetrue (True in Visual Basic) and modify parameters that defines a vault to which to connect (on input these parameters are defined by the client application that submitted the task).

By default, the connection is made from behalf of the user account of the Task Server (usually 'SYSTEM'). To use another account override the method and specify correct userName and password.

See Also