ISecurityTrimmer2.CheckAccess Method

When implemented in a class, determines whether the user should see the individual Search results.

Namespace:  Microsoft.Office.Server.Search.Query
Assembly:  Microsoft.Office.Server.Search (in Microsoft.Office.Server.Search.dll)

Syntax

'Declaration
Function CheckAccess ( _
    documentCrawlUrls As IList(Of String), _
    sessionProperties As IDictionary(Of String, Object), _
    userIdentity As IIdentity _
) As BitArray
'Usage
Dim instance As ISecurityTrimmer2
Dim documentCrawlUrls As IList(Of String)
Dim sessionProperties As IDictionary(Of String, Object)
Dim userIdentity As IIdentity
Dim returnValue As BitArray

returnValue = instance.CheckAccess(documentCrawlUrls, _
    sessionProperties, userIdentity)

BitArray CheckAccess(
    IList<string> documentCrawlUrls,
    IDictionary<string, Object> sessionProperties,
    IIdentity userIdentity
)

Parameters

• documentCrawlUrls
  Type: System.Collections.Generic.IList<String>

  The collection of crawl URLs to trim.

• sessionProperties
  Type: System.Collections.Generic.IDictionary<String, Object>

  The properties of the query.

• userIdentity
  Type: System.Security.Principal.IIdentity

  The identity of the user who issued the query.

Return Value

Type: System.Collections.BitArray
A bitmask that specifies whether the crawl URL at that location in the documentCrawlUrls parameter should be displayed in the Search results.

Remarks

The bitmask must have one bit for each of the items in the documentCrawlUrls parameter. If the bitmask has a value of 1, the corresponding crawl URL should be displayed in the Search results; otherwise the crawl URL should not be displayed in the Search results.

See Also

Reference

ISecurityTrimmer2 Interface

ISecurityTrimmer2 Members

Microsoft.Office.Server.Search.Query Namespace