BeginGetPreferenceBundle Method
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.
Get the preference bundle identified by the specified label for the currently logged in user. The sequence ID indicates the version number known to the requestor. If the requested ID matches the server version, no preference will be returned.
Namespace: Microsoft.Rtc.Collaboration.GroupChat
Assembly: Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
'Declaration
Public Function BeginGetPreferenceBundle ( _
label As String, _
seqId As Integer, _
provideDefault As Boolean, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As GroupChatServices
Dim label As String
Dim seqId As Integer
Dim provideDefault As Boolean
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginGetPreferenceBundle(label, _
seqId, provideDefault, userCallback, _
state)
public IAsyncResult BeginGetPreferenceBundle(
string label,
int seqId,
bool provideDefault,
AsyncCallback userCallback,
Object state
)
Parameters
- label
Type: System.String
The preference label.
- seqId
Type: System.Int32
The preference sequence ID. Every time theGroupChatPreferenceBundleis accessed, whether for read or write, the SequenceId is incremented.
- provideDefault
Type: System.Boolean
If true, the server will attempt to vend a default value for the requested preference, if no value is defined for the given label.
- 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 |
|---|---|
| [System.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 EndGetPreferenceBundle(IAsyncResult) to complete this asynchronous operation.