Share via

ChatRoomCategoryManagementServices.BeginFindCategoriesByCriteria Method

  • Article

Finds all categories matching the given criteria. The criteria must appear as a substring of the category name, or if searchDescription is true, as a substring of the category description.

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

Syntax

'Declaration
Public Function BeginFindCategoriesByCriteria ( _
    criteria As String, _
    searchDescription As Boolean, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomCategoryManagementServices
Dim criteria As String
Dim searchDescription As Boolean
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginFindCategoriesByCriteria(criteria, _
    searchDescription, userCallback, _
    state)

public IAsyncResult BeginFindCategoriesByCriteria(
    string criteria,
    bool searchDescription,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • searchDescription
    Type: System.Boolean
    if set to true this operation will also search category descriptions.
  • 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 EndFindCategoriesByCriteria(IAsyncResult) to complete this asynchronous operation.

See Also

Reference

ChatRoomCategoryManagementServices Class

ChatRoomCategoryManagementServices Members

Microsoft.Rtc.Collaboration.GroupChat.Management Namespace