Asynchronously removes 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 RemoveProfileItemAsync(
	string namespacePath,
	string key,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub RemoveProfileItemAsync ( _
	namespacePath As String, _
	key As String, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

namespacePath
Type: System..::..String
The namespace path.
key
Type: System..::..String
The key.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The AsyncCompletedEventArgs instance containing the event data.
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.

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 item cannot be modified because CanEditProfileItems is trueTruetruetrue (True in Visual Basic).

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