Asynchronously sets the password for this session user.

Namespace: ININ.IceLib.Configuration
Assembly: ININ.IceLib.Configuration (in ININ.IceLib.Configuration.dll) Version: (


public void SetPasswordAsync(
	string newPassword,
	bool force,
	AsyncCompletedEventHandler completedCallback,
	Object userState
Visual Basic
Public Sub SetPasswordAsync ( _
	newPassword As String, _
	force As Boolean, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _


Type: System..::..String
The new password.
Type: System..::..Boolean
If set to trueTruetruetrue (True in Visual Basic) attempt to force the password change by bypassing the password policy, otherwise return password policy violation errors that may occur.
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
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.


The password policy can be overridden by setting force to trueTruetruetrue (True in Visual Basic) only if the user has Master Administrator rights. If the password cannot be set and the server is not able to override the password policy an IceLibException containing the error message will be returned in the AsyncCompletedEventArgs.Error property.

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.


System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing 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 SU 7 and beyond.

See Also