BCTaskObjectOnConnect Method

protected virtual bool OnConnect(
	ref string machineName,
	ref string vaultOrDataStoreName,
	ref string workAreaID,
	ref string userName,
	out string password
)

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

Parameters

machineName

Type: SystemString
The name of the server machine. If or an empty string, then a local machine is used.

vaultOrDataStoreName

Type: SystemString
The name of the vault or data store. If or an empty string, then the default vault will be opened.

workAreaID

Type: SystemString
The ID property value of a work area in the vault. If or an empty string, then the vault will be opened in the context of the main area.

userName

Type: SystemString
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: SystemString
The password for the user account that will be used to connect to the vault.

Return Value

If access to a vault is required, return 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.

Reference