IVMVirtualServer::GetVirtualMachineFiles method

The GetVirtualMachineFiles method returns an array of known virtual machine configuration files.

Syntax

HRESULT GetVirtualMachineFiles(
  [in]  VARIANT      inAdditionalSearchPaths,
  [in]  VARIANT_BOOL inExcludedRegisteredVMs,
  [out] VARIANT      *outVirtualMachineFileList
);

Parameters

inAdditionalSearchPaths [in]

These paths will be searched along with the paths set in the IVMVirtualServer::SearchPaths and IVMVirtualServer::DefaultVMConfigurationPath properties.

inExcludedRegisteredVMs [in]

Set to TRUE if registered virtual machines should be excluded from the array return in the outVirtualMachineFileList parameter.

outVirtualMachineFileList [out]

An array of virtual machine configuration files found in the specified search paths.

Return value

This method supports standard return values, as well as the following. For information on Virtual Server specific return values not listed below, see HRESULT Codes Specific to the Virtual Server.

Return code Description
S_OK
The operation was successful.
E_POINTER
The outVirtualMachineFileList parameter is NULL.
E_INVALIDARG
The inAdditionalSearchPaths parameter is not an array of strings.
DISP_E_EXCEPTION
An unexpected error has occurred.

Remarks

The search paths used to retrieve the array of configuration files will include those set previously by IVMVirtualServer::SearchPaths and IVMVirtualServer::DefaultVMConfigurationPath in addition to those specified by the inAdditionalSearchPaths parameter.

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

IVMVirtualServer