IVMVirtualMachine::Notes property

  • Article

The Notes property contains notes about the virtual machine.

This property is read/write.

Syntax

HRESULT put_Notes(
  [in]  BSTR virtualMachineNotes
);

HRESULT get_Notes(
  [out] BSTR *virtualMachineNotes
);

VB 
VMVirtualMachine.Notes( _
  ByRef virtualMachineNotes, _
  ByVal virtualMachineNotes _
)

Property value

The user-defined notes about the virtual machine. The maximum length of the string is 40,000 characters.

This property value is read/write.

Error codes

Name Meaning
S_OK
 The operation was successful.
E_POINTER
 The virtualMachineNotes parameter is NULL.
E_INVALIDARG
 The virtualMachineNotes parameter is not valid or contains more than 40,000 characters.
VM_E_VM_UNKNOWN
 The configuration is unknown.
DISP_E_EXCEPTION
 An unexpected error has occurred.

Remarks

Pass an empty string to remove any notes.

Examples

The following example displays the Notes property value of a VMVirtualMachine object.

Set objVS = CreateObject("VirtualServer.Application")
Set objVM = objVS. FindVirtualMachine("Windows Server 2003")

Wscript.Echo "VM Name: " & objVM.Name
WScript.Echo "Notes: " & objVM.Notes

Requirements
Product
 Microsoft Virtual Server 2005 onWindows Server 2003
Download
 Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003
Header
VsComInterfaces.h

See also

IVMVirtualMachine