RasEntry.Rename Method

DotRas SDK

Collapse image Expand Image Copy image CopyHover image
Renames the entry.

Namespace: DotRas
Assembly: DotRas (in DotRas.dll) Version: 1.3.5166.33435 (1.3.0.0)

Syntax

C#
public bool Rename(
	string newEntryName
)
Visual Basic
Public Function Rename ( 
	newEntryName As String
) As Boolean
Visual C++
public:
bool Rename(
	String^ newEntryName
)
F#
member Rename : 
        newEntryName : string -> bool 

Parameters

newEntryName
Type: System..::..String
Required. The new name of the entry.

Return Value

Type: Boolean
true if the operation was successful, otherwise false.

Exceptions

Exception Condition
System..::..ArgumentException newEntryName is an empty string or null reference (Nothing in Visual Basic) or newEntryName is invalid.
System..::..UnauthorizedAccessException The current user does not have permissions to the phone book specified.

See Also