Asynchronously gets the specified profile item.

Namespace: ININ.IceLib.Connection.Extensions
Assembly: ININ.IceLib (in ININ.IceLib.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void GetProfileItemAsync(
	string namespacePath,
	string key,
	EventHandler<GetProfileItemCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub GetProfileItemAsync ( _
	namespacePath As String, _
	key As String, _
	completedCallback As EventHandler(Of GetProfileItemCompletedEventArgs), _
	userState As Object _
)

Parameters

namespacePath
Type: System..::..String
The namespace path.
key
Type: System..::..String
The key.
completedCallback
Type: System..::..EventHandler<(Of <(<'GetProfileItemCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

This method will return the value from the cache, if the attribute is cached. If the attribute is not being cached, it will send a request to the server and get the attribute.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionThe namespacePath or key length is zero.
ININ.IceLib..::..IceLibExceptionThe custom profile information could not be retrieved.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also