M-Files API 22.6.11519.0
GetMFilesURLForObject Method
VaultObjectOperations Object : GetMFilesURLForObject Method
The ID of the object for which the URL is requested.
The target version of the object. Valid only if "SpecificVersion" is true.
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.
The type of the requested URL.
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
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
ValueDescription
MFilesURLTypeEditSpecifies an URL for performing the open-for-edit action for the target file.
MFilesURLTypeOpenSpecifies an URL for performing the default open action for the target file.
MFilesURLTypeShowSpecifies an URL for showing the object version. The URL does not open the target file.
MFilesURLTypeShowMetadataSpecifies an URL for showing the metadata card for the target object.
MFilesURLTypeViewSpecifies an URL for performing the read-only open action for the target file.
The type of the requested URL.
See Also

VaultObjectOperations Object  | VaultObjectOperations Members