ConnectInteractive Method

Specifies the communication port on which the server listens for calls.

With the TCP/IP protocol, specify the TCP port that M-Files Server is listening to. Typically this value is 2266.

With the HTTPS protocol, specify the M-Files Server endpoint that will be used between the RPC Proxy and M-Files Server on the server side. Typically this value is 4466. Note that this parameter does not affect the port that the client uses to communicate with the server. Regardless of this setting, the client will always use the standard HTTPS port for communicating with the server.

With the LPC protocol, specify "MFServerCommon_F5EE352D-6A03-4866-9988-C69CEA2C39BF" to connect to the local M-Files Server instance regardless of its version. If multiple versions of M-Files Server are running on the same computer, the first instance that has started has been registered to listen to this endpoint. Alternatively, you can leave this parameter empty in order to connect to the exact same version of M-Files Server as the M-Files API version you are using. If you leave the Endpoint parameter empty with the LPC protocol, M-Files API uses a version-specific endpoint name to connect to M-Files Server.

The default endpoint for the gRPC protocol is 7766. With the local gRPC protocol, use the version of the M-Files Server instance you are connecting to as the endpoint value. For instance, 20.9.9403.0. Use an empty value for referring to the current installation.

Description

Connects to the specified server interactively.

Syntax

Visual Basic
Public Function ConnectInteractive( _ ByVal ServerDisplayName As String, _ ByVal ParentWindow As Long, _ ByVal ReturnNoneIfCancelledByUser As Boolean, _ Optional ByVal TimeZone As TimeZoneInformation = 0, _ Optional ByVal DefaultAuthType As MFAuthType = MFAuthTypeLoggedOnWindowsUser, _ Optional ByVal SPN As Variant, _ Optional ByVal ProtocolSequence As String = "ncacn_ip_tcp", _ Optional ByVal NetworkAddress As String = "localhost", _ Optional ByVal Endpoint As String = 2266, _ Optional ByVal EncryptedConnection As Boolean = False, _ Optional ByVal LocalComputerName As String = "", _ Optional ByVal AllowAnonymousConnection As Boolean = False, _ Optional ByVal AllowUsingAuthenticationPlugins As Boolean = True, _ Optional ByVal LogicalTargetServer As String = "", _ Optional ByVal ClientCulture As String = "", _ Optional ByVal AdditionalInfoAsJSON As String = "", _ Optional ByVal ReturnUnmanagedContent As Boolean = True _ ) As MFServerConnection

Visual Basic

Public Function ConnectInteractive( _
   ByVal ServerDisplayName As String, _
   ByVal ParentWindow As Long, _
   ByVal ReturnNoneIfCancelledByUser As Boolean, _
   Optional ByVal TimeZone As TimeZoneInformation = 0, _
   Optional ByVal DefaultAuthType As MFAuthType = MFAuthTypeLoggedOnWindowsUser, _
   Optional ByVal SPN As Variant, _
   Optional ByVal ProtocolSequence As String = "ncacn_ip_tcp", _
   Optional ByVal NetworkAddress As String = "localhost", _
   Optional ByVal Endpoint As String = 2266, _
   Optional ByVal EncryptedConnection As Boolean = False, _
   Optional ByVal LocalComputerName As String = "", _
   Optional ByVal AllowAnonymousConnection As Boolean = False, _
   Optional ByVal AllowUsingAuthenticationPlugins As Boolean = True, _
   Optional ByVal LogicalTargetServer As String = "", _
   Optional ByVal ClientCulture As String = "", _
   Optional ByVal AdditionalInfoAsJSON As String = "", _
   Optional ByVal ReturnUnmanagedContent As Boolean = True _
) As MFServerConnection

Parameters

ServerDisplayName

The display name of the server to connect to. Depending on the authentication type, may appear in the login user interface.

ParentWindow

The parent window for any number of possible dialogs.

ReturnNoneIfCancelledByUser

If this is set to "true" and the user cancels the connection attempt, "None" is returned. Otherwise, an error code is returned.

TimeZone

Optional parameter. The time zone.

DefaultAuthType

Value	Description
MFAuthTypeLoggedOnWindowsUser	Windows authentication with current user credentials.
MFAuthTypeSpecificMFilesUser	M-Files authentication, user needs to specify the credentials.
MFAuthTypeSpecificWindowsUser	Windows authentication, user needs to specify the credentials.
MFAuthTypeUnknown	Unspecified authentication method.

Indicates an authentication type as one value of the MFAuthType enumeration. The default value indicates the current logged on Windows user (MFAuthTypeLoggedOnWindowsUser).

SPN

The service principal name (SPN).

ProtocolSequence

Protocol sequence name to be used in server communication. Supported protocols include:

"ncacn_ip_tcp" (TCP/IP protocol)
"ncacn_spx" (SPX protocol)
"ncalrpc" (local interprocess call, LPC)
"ncacn_http" (HTTPS)
"grpc" (gRPC)
"grpc-local" (local gRPC)

NetworkAddress

The network address of a server computer. Either a human readable computer name or an IP address in dotted decimal format. The default value is "localhost".

Endpoint

Specifies the communication port on which the server listens for calls.

With the TCP/IP protocol, specify the TCP port that M-Files Server is listening to. Typically this value is 2266.

EncryptedConnection

Specifies whether to encrypt data between the M-Files Client service and the M-Files Server service. Applies to certain protocol sequences only.

With non-local gRPC, the value must be true when the server you are connecting to uses TLS and false when the server does not use TLS. With local gRPC, the recommended value is false.

LocalComputerName

The name of the client computer (the host name of the client). If empty, the system-supplied name of the local computer is used.

AllowAnonymousConnection

If this is set to "true", anonymous connections can be attempted. This can be used to retrieve replicated vaults.

AllowUsingAuthenticationPlugins

If this is set to "true", authentication plugin configurations are used for authentication.

LogicalTargetServer

The name of the computer that the user attempts to connect to.

ClientCulture

The specified client culture information. See also ClientCulture Property.

AdditionalInfoAsJSON

Additional information (such as a client certificate) as JSON.

ReturnUnmanagedContent

If this is set to "true", unmanaged content is returned.

Remarks

Requires M-Files 12.0.6700.0 or later.