GetAuthenticationPluginInformationEx 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.

Description

Gets the authentication plugin information for the specified authentication request. Returns NULL if no plugin is configured for the request.

Syntax

Visual Basic
Public Function GetAuthenticationPluginInformationEx( _ Optional ByVal UserName As String = "", _ Optional ByVal Domain As String = "", _ Optional ByVal VaultGUID As String = "", _ Optional ByVal HostName As String = "", _ Optional ByVal AccountType As MFLoginAccountType = MFLoginAccountTypeWindows, _ Optional ByVal TargetPluginName As String = "", _ 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 _ ) As PluginInfos

Visual Basic

Public Function GetAuthenticationPluginInformationEx( _
   Optional ByVal UserName As String = "", _
   Optional ByVal Domain As String = "", _
   Optional ByVal VaultGUID As String = "", _
   Optional ByVal HostName As String = "", _
   Optional ByVal AccountType As MFLoginAccountType = MFLoginAccountTypeWindows, _
   Optional ByVal TargetPluginName As String = "", _
   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 _
) As PluginInfos

Parameters

UserName

If not empty, specifies the user name.

Domain

If not empty, specifies the domain name.

VaultGUID

If not empty, specifies the GUID of the target vault.

HostName

If not empty, specifies the target hostname. If provided, acctType must be eatUnknown, and UserName/Domain/VaultGUID must be empty.

AccountType

Value	Description
MFLoginAccountTypeMFiles	Specifies the login with M-Files credentials.
MFLoginAccountTypeWindows	Specifies the login with Windows credentials.

Specifies the preferred account type.

TargetPluginName

Obsolete. With M-Files 2017 and later, the value must always be empty. Defining a value causes an error to be displayed when this method is used.

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. 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 data between M-Files Client and M-Files Server must be encrypted. May apply to certain protocol sequences only.