GetMFilesURLForObject Method

Description

Gets an M-Files URL for the specified object.

Syntax

Visual Basic
Public Function GetMFilesURLForObject( _ ByVal ObjID As ObjID, _ ByVal TargetVersion As Long, _ ByVal SpecificVersion As Boolean, _ Optional ByVal URLType As MFilesURLType = MFilesURLTypeShow _ ) As String

Visual Basic

Public Function GetMFilesURLForObject( _
   ByVal ObjID As ObjID, _
   ByVal TargetVersion As Long, _
   ByVal SpecificVersion As Boolean, _
   Optional ByVal URLType As MFilesURLType = MFilesURLTypeShow _
) As String

Parameters

ObjID

The ID of the object for which the URL is requested.

TargetVersion

The target version of the object. Valid only if "SpecificVersion" is true.

SpecificVersion

Specifies whether to target a specific version of the object. If false, the generated URL points to the latest version. If true, "TargetVersion" must be provided.

URLType

Value	Description
MFilesURLTypeEdit	Specifies an URL for performing the open-for-edit action for the target file.
MFilesURLTypeOpen	Specifies an URL for performing the default open action for the target file.
MFilesURLTypeShow	Specifies an URL for showing the object version. The URL does not open the target file.
MFilesURLTypeShowMetadata	Specifies an URL for showing the metadata card for the target object.
MFilesURLTypeView	Specifies an URL for performing the read-only open action for the target file.

The type of the requested URL.