M-Files API 22.6.11519.0
GetObjectLocationsInView Method
VaultObjectOperations Object : GetObjectLocationsInView Method

If the target object exists with versions 1 and 2, the following table summarizes the L or S specific segments of the returned location paths:

Flag value Requested version 1 Requested version 2 Requested version -1

MFLatestSpecificBehaviorNormal

S/v1

L/L
S/v2

L/L
S/v2
S/v1

MFLatestSpecificBehaviorSpecific

S/v1 S/v2 S/v2
S/v1

MFLatestSpecificBehaviorLatest

[none] L/L L/L

MFLatestSpecificBehaviorAutomatic

S/v1 L/L L/L
S/v1

Note that for the requested version -1 this method returns locations for each version when MFLatestSpecificBehaviorNormal or MFLatestSpecificBehaviorSpecific is used. With MFLatestSpecificBehaviorAutomatic, one location is returned for each version.

Description
Gets the locations of the object in a view.
Syntax
Visual Basic
Public Function GetObjectLocationsInView( _
   ByVal View As Long, _
   ByVal LatestSpecificBehavior As MFLatestSpecificBehavior, _
   ByVal ObjectVersion As ObjVer _
) As Strings
Parameters
View
LatestSpecificBehavior
ValueDescription
MFLatestSpecificBehaviorAutomaticAutomatically chooses the LatestOnly behavior (L folder) if the object version is the latest version. Otherwise, it chooses the SpecificOnly behavior (S folder). Only one location is ever returned when using this method.
MFLatestSpecificBehaviorLatestReturns a location in the L (Latest) folder only. (Otherwise the latest version is shown in both the L and S folders.)
MFLatestSpecificBehaviorNormalNormal behavior can return locations in both the L and S folders.
MFLatestSpecificBehaviorSpecificReturns a location in the S (Specific) folder only, even if evaluating the latest version.

If the target object exists with versions 1 and 2, the following table summarizes the L or S specific segments of the returned location paths:

Flag value Requested version 1 Requested version 2 Requested version -1

MFLatestSpecificBehaviorNormal

S/v1

L/L
S/v2

L/L
S/v2
S/v1

MFLatestSpecificBehaviorSpecific

S/v1 S/v2 S/v2
S/v1

MFLatestSpecificBehaviorLatest

[none] L/L L/L

MFLatestSpecificBehaviorAutomatic

S/v1 L/L L/L
S/v1

Note that for the requested version -1 this method returns locations for each version when MFLatestSpecificBehaviorNormal or MFLatestSpecificBehaviorSpecific is used. With MFLatestSpecificBehaviorAutomatic, one location is returned for each version.

ObjectVersion
Remarks

This method is available only if M-Files API is used in the client interface mode.

See Also

VaultObjectOperations Object  | VaultObjectOperations Members