GetFacetValuesByPath Method

Description

Retrieves the facet values for the objects that satisfy the search conditions extracted from the temporary search view specified by the path.

Syntax

Visual Basic
Public Function GetFacetValuesByPath( _ ByVal RelativePath As String, _ ByVal Facets As Expressions, _ ByVal FacetValuesMaxCount As Long, _ ByVal Flags As MFFacetSearchFlags _ ) As StringData

Visual Basic

Public Function GetFacetValuesByPath( _
   ByVal RelativePath As String, _
   ByVal Facets As Expressions, _
   ByVal FacetValuesMaxCount As Long, _
   ByVal Flags As MFFacetSearchFlags _
) As StringData

Parameters

RelativePath

The relative path in the vault.

Facets

The facets as expressions.

FacetValuesMaxCount

The maximum number of facet values returned for each facet. Use 0 to retrieve all facet values.

Flags

Value	Description
MFFacetSearchFlagAscendingOrder	Orders to use an ascending sorting order if the facet values are to be sorted.
MFFacetSearchFlagIgnoreFacetGroupPermissions	Orders to perform no ACL check on facet groups.
MFFacetSearchFlagIgnoreFacetValuePermissions	Orders to perform no ACL check on individual facet values.
MFFacetSearchFlagIgnoreSearchPermissions	Orders to perform no ACL check on the underlying search results.
MFFacetSearchFlagNone	No flags.
MFFacetSearchFlagOverrideByConfiguration	Orders to override the facet search parameters by configuration if available.
MFFacetSearchFlagSortFacetValues	Orders to sort facet values in descending occurrence order within each facet group.

Remarks

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