ConnectionServicesConnect Method |
Connects to a FactoryLogix xTend Integration Server.
Namespace:
FactoryLogix.xTend.Core
Assembly:
FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.245.0.0 (8.245.0.0)
Syntax public Guid Connect(
string serverName,
string userName,
string password,
string databaseConnection,
string cultureName = null
)
Public Function Connect (
serverName As String,
userName As String,
password As String,
databaseConnection As String,
Optional cultureName As String = Nothing
) As Guid
public:
virtual Guid Connect(
String^ serverName,
String^ userName,
String^ password,
String^ databaseConnection,
String^ cultureName = nullptr
) sealed
abstract Connect :
serverName : string *
userName : string *
password : string *
databaseConnection : string *
?cultureName : string
(* Defaults:
let _cultureName = defaultArg cultureName null
*)
-> Guid
override Connect :
serverName : string *
userName : string *
password : string *
databaseConnection : string *
?cultureName : string
(* Defaults:
let _cultureName = defaultArg cultureName null
*)
-> Guid
Parameters
- serverName
- Type: SystemString
The fully qualified domain name (FQDN) or simple computer name of the xTend integration server. For example, "xTendServer.mydomain.local" or "xTendServer" - userName
- Type: SystemString
The username of a FactoryLogix user account with "xTend API" privileges. - password
- Type: SystemString
The password associated with xTend API user account being utilized for connection. - databaseConnection
- Type: SystemString
The name of the database connection on the xTend server that should be used for all subsequent API service calls. - cultureName (Optional)
- Type: SystemString
The culture name used to determine the language used to output messages from the server to the user interface.
Remarks For a list of predefined culture names, see the National Language Support (NLS) API Reference at the Go Global Developer Center.
Return Value
Type:
GuidOn successful connection, a 128-bit unique identifier (Guid) is returned which uniquely identifies this session. This "Session ID" will be passed to all subsequent API service calls to identify the caller.
Exceptions See Also