IWsEndUserSetChangeNoteServer Method
|
Adds header information to the notes of a server. Using the method SetChangeNoteServer () WsEndUser of Aruba, you can add,
edit, or delete notes associated with the specified virtual server. And 'possible to completely erase notes, setting
a string empty string. Inserting a new note overwrites the previously stored known. Each virtual server
You can associate a single note. The format of the note can be plain text (plain text) or HTML text
(ie text formatted using HTML tags).
Namespace:
Aruba.Cloud.WsEndUser
Assembly:
Aruba.Cloud.WsEndUser (in Aruba.Cloud.WsEndUser.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax[OperationContractAttribute]
WsResult SetChangeNoteServer(
int serverId,
string note
)
<OperationContractAttribute>
Function SetChangeNoteServer (
serverId As Integer,
note As String
) As WsResult
[OperationContractAttribute]
WsResult^ SetChangeNoteServer(
int serverId,
String^ note
)
[<OperationContractAttribute>]
abstract SetChangeNoteServer :
serverId : int *
note : string -> WsResult
function SetChangeNoteServer(
serverId : int,
note : String
) : WsResult
Parameters
- serverId
- Type: SystemInt32
Value of type System.Int32 which is the unique identifier of the server that you want to edit notes
- note
- Type: SystemString
Value of type System.String that represents the notes you want to associate with the specified virtual server
Return Value
Type:
WsResult
The method returns an object WsResult contains information about the method call.
For further details on the information returned by the method see the class definition
WsResult.
Examples
The following example shows a custom method, called AddServerNote(), which means a call to SetChangeNoteServer()
to Aruba WsEndUser, set notes for the server with ID 635.
private static void AddServerNote(WsEndUserClient client)
{
try
{
WsResult result = client.SetChangeNoteServer(635, "This is the note to be added to the Server");
if (!result.Success)
{
throw new ApplicationException(String.Format(
"An error has occurred while invoking GetUserInfo(). {0}", result.ResultMessage));
}
}
catch (Exception ex)
{
throw new ApplicationException(String.Format(
"An error has occurred while setting server note {0}", ex.Message));
}
}
See Also