Click or drag to resize

CrestronFileTransferClientSetUserName Method

Sets the user name to be used in protocol authentication.

Namespace: Crestron.SimplSharp
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public int SetUserName(
	string name
)

Parameters

name  String
The user name to use for the transfer

Return Value

Int32
Zero if successful. -1 if underlying object has not been properly initialized. 1 if internal error occurred. Use GetLastClientError() to retrieve the error code. 87 if invalid parameter was passed.
Exceptions
ExceptionCondition
ObjectDisposedExceptionThe FTC Client has already been closed or disposed.
Remarks
In order to specify the password to be used in conjunction with the user name use SetPassword method. Non-ASCII characters are not currently supported.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also