The VaultConnection class represents a document vault connection that is available to the current Windows user.
Description
Public Methods
 BindToVault | Binds to the vault identified by this vault connection. The default authentication method is used if the login is allowed. |
| Clone | Creates a copy of the object. |
| GetGUID | Gets the GUID on the server of the vault identified by this vault connection. |
| IsLoggedIn | Checks whether the current user is currently logged into the vault identified by this vault connection. |
| LogInAs | Logs in to the vault. Prompts the user for credentials. |
| LogInAsUser | Logs in to the vault using the specified credentials. |
| TestConnectionToVault | Tests the connection to the vault identified by this vault connection. |
Public Properties
 AuthType | The type of the authentication. |
| AutoLogin | Specifies if M-Files should automatically log in to this vault when the system is started. |
| EncryptedConnection | Specifies if data between M-Files Desktop and M-Files Server must be encrypted. May apply to certain protocol sequences only. |
| Endpoint | The endpoint for connecting to the vault.
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. |
| Icon | If not NULL, contains the icon of this item in .ICO format. |
| Name | The name of the vault identified by this vault connection. |
| NetworkAddress | The network address for connecting to the vault. |
| ProtocolSequence | The protocol sequence for connecting to the vault. |
| ServerVaultGUID | The GUID of the vault on the server. |
| ServerVaultName | The name of the vault on the server. |
| UserSpecific | Specifies if this connection is user specific or visible to all users. |
Remarks
Vault connections listed in Windows File Explorer.
See Also