M-Files API 22.6.11519.0
MFilesClientApplication Object
Members 
Description
The MFilesClientApplication class represents connection to the client.

The MFilesClientApplication class represents an M-Files Client application.

The MFilesClientApplication class is the high-level object of the M-Files API component. This is the first object you create when writing an application that interacts with Windows Explorer using M-Files API.

Public Methods
Adds a new vault connection to the collection of vaults configured in M-Files Desktop.
Binds to a vault with the specified name (e.g., 'Sample Vault'). The default authentication method is used if the login is allowed.
Gets a file based on the specified path.
Gets an object based on the specified path.
Receives the version of the API.
Returns the current M-Files software language.
Receives the version of the client.
Gets the drive letter of M-Files Desktop.
Returns the vault connection with the specified name.
Returns a collection of vaults configured in M-Files Desktop.
Returns a collection of vaults with the specified GUID configured in M-Files Desktop.
Checks whether the specified path refers to an object in M-Files.
Logs in to the vault with the specified name (e.g., 'Sample Vault'). Prompts the user for credentials.
Logs in to the vault with the specified name (e.g., 'Sample Vault') using the specified credentials.
Deletes the vault connection with the specified name from the collection of vaults configured in M-Files Desktop.
Displays a tooltip message over M-Files status icon.
Tests the connection to the specified server.
Remarks

Accessing M-Files through this interface allows your application to use M-Files client application services. In addition, objects acquired by using this interface use the M-Files client application for their operations. Objects and actions behave similarly when accessed from the M-Files user interface (e.g., the objects use local caches and the actions performed in API are visible from the user interface).

You should use either the client or server application interface, but not both of them. Mixing objects from different interfaces may yield unpredictable results.

Example
Creating an MFilesClientApplication object and accessing the vault (Visual Basic) Copy Code

' Initialize the MFilesClientApplication object.
Dim oClientApp As New MFilesAPI.MFilesClientApplication

' Log in to a vault through document vault connection "Demo". Me refers to the current form
' of the calling application.
Dim oVaultConnection As MFilesAPI.VaultConnection = oClientApp.GetVaultConnection("Demo")
Dim oVault As MFilesAPI.Vault = oVaultConnection.BindToVault(Me.Handle, True, True)

See Also

MFilesClientApplication Members  | MFilesServerApplication Object