TestConnectionToServerEx Method

Description

Tests the connection to the specified server.

Syntax

Visual Basic
Public Function TestConnectionToServerEx( _ Optional ByVal Server As String = "localhost", _ Optional ByVal Port As String = 2266, _ Optional ByVal ProtocolSequence As String = "ncacn_ip_tcp", _ Optional ByVal EncryptedConnection As Boolean = False _ ) As Long

Visual Basic

Public Function TestConnectionToServerEx( _
   Optional ByVal Server As String = "localhost", _
   Optional ByVal Port As String = 2266, _
   Optional ByVal ProtocolSequence As String = "ncacn_ip_tcp", _
   Optional ByVal EncryptedConnection As Boolean = False _
) As Long

Parameters

Server

Server address as an IP number or computer name. Not used with the LPC protocol.

Port

Server port for remote protocols. Not used with the LPC protocol.

The default M-Files server port is 2266.

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)

EncryptedConnection

Specifies whether data between M-Files Client and M-Files Server must be encrypted. May apply to certain protocol sequences only.

Return Type

Round-trip time in milliseconds

Remarks

This method tests the end-to-end RPC connection to the server. This method does not require any authentication, and it does not do anything else. It raises an error if the server connection test fail.