Sets the password for this session user.

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

Syntax

C#
public void SetPassword(
	string newPassword,
	bool force
)
Visual Basic
Public Sub SetPassword ( _
	newPassword As String, _
	force As Boolean _
)

Parameters

newPassword
Type: System..::..String
The new password.
force
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.

Remarks

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 thrown.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
ININ.IceLib..::..IceLibExceptionThe password was unable to be set.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

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