BeginFindUsersOrGroupsByCriteria Method

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Finds users or groups whose name contains a specified search string. Users having an email address or SIP URI containing the search string will also be returned.

Namespace:  Microsoft.Rtc.Collaboration.GroupChat.Management
Assembly:  Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)

Syntax

'Declaration
Public Function BeginFindUsersOrGroupsByCriteria ( _
    criteria As String, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult

'Usage
Dim instance As GroupChatUserAdministrationServices
Dim criteria As String
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginFindUsersOrGroupsByCriteria(criteria, _
    userCallback, state)

public IAsyncResult BeginFindUsersOrGroupsByCriteria(
    string criteria,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • criteria
    Type: System.String
    The search string, which will match against the name, email address, or SIP URI.
  • userCallback
    Type: System.AsyncCallback
    The method to be invoked when this asynchronous operation completes.
  • state
    Type: System.Object
    An object to be passed back to the callback.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references this operation.

Exceptions

Exception Condition
ArgumentException

Thrown when invalid arguments are passed.
[Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException]

Thrown when the GroupChatEndpoint is not established.
[System.InvalidOperationException]

Thrown when the chat server connection is not in a valid state to send the command.
[RealTimeException]

Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server.

Remarks

This request will be processed asynchronously. See EndFindUsersOrGroupsByCriteria(IAsyncResult) to complete this asynchronous operation.

See Also

Reference

GroupChatUserAdministrationServices Class

GroupChatUserAdministrationServices Members

Microsoft.Rtc.Collaboration.GroupChat.Management Namespace