IVMVirtualMachine::FetchScriptByEvent method

The FetchScriptByEvent method retrieves the script command line associated with the specified event type.

Syntax

HRESULT FetchScriptByEvent(
  [in]  VMEventType eventType,
  [out] BSTR        *scriptCommandLine
);

Parameters

eventType [in]

The event type.

scriptCommandLine [out]

Command line that will be executed when the specified event occurs.

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_INVALIDARG	The eventType parameter is not valid.
E_POINTER	The scriptCommandLine parameter is NULL.
VM_E_VM_UNKNOWN	The configuration is unknown.
DISP_E_EXCEPTION	An unexpected error has occurred.

Remarks

The output command line string will be NULL if there is no command attached to the specified event type. Scripts attached to an event will be launched automatically by Virtual Server when the event occurs.

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

VMEventType