M-Files API 23.11.13135.0
GetRelationshipsEx Method
VaultObjectOperations Object : GetRelationshipsEx Method
The object version the relationships of which to get.
The relationship direction.

If this is set to "true", the retrieved relationships of the specified object are guaranteed to contain a maximum of 50 results from all object types. If this is set to "false", however, and the number of relationships that the object has exceeds the maximum number of allowed results (500 by default), the results may contain only a subset of all the object types. In other words, if set to "true", the relationship retrieval works the same way as M-Files search operations normally do.

However, in some cases, the limits indicated above may slightly vary as they apply only to relationships TO the specified object. In other words, relationship FROM the specified object are not limited. Consequently, if the "MFRelationshipsModeAll" mode is used (combining the TO and FROM results), the overall number of the returned related objects may not exactly match the indicated limits.

 

Description
Gets all the relationships of the specified object.
Syntax
Visual Basic
Public Function GetRelationshipsEx( _
   ByVal ObjVer As ObjVer, _
   ByVal Mode As MFRelationshipsMode, _
   ByVal SearchInEachObjectType As Boolean _
) As ObjectVersions
Parameters
ObjVer
The object version the relationships of which to get.
Mode
ValueDescription
MFRelationshipsModeAllRelationships FROM and TO the specified object.
MFRelationshipsModeFromThisObjectRelationships FROM the specified object.
MFRelationshipsModeToThisObjectRelationships TO the specified object.
The relationship direction.
SearchInEachObjectType

If this is set to "true", the retrieved relationships of the specified object are guaranteed to contain a maximum of 50 results from all object types. If this is set to "false", however, and the number of relationships that the object has exceeds the maximum number of allowed results (500 by default), the results may contain only a subset of all the object types. In other words, if set to "true", the relationship retrieval works the same way as M-Files search operations normally do.

However, in some cases, the limits indicated above may slightly vary as they apply only to relationships TO the specified object. In other words, relationship FROM the specified object are not limited. Consequently, if the "MFRelationshipsModeAll" mode is used (combining the TO and FROM results), the overall number of the returned related objects may not exactly match the indicated limits.

 

See Also

VaultObjectOperations Object  | VaultObjectOperations Members