Edit

Share via

IVMGuestOS::Logoff method

  • Article

[Windows Virtual PC is no longer available for use as of Windows 8. Instead, use the Hyper-V WMI provider (V2).]

Logs off all users from the guest operating system.

Syntax

HRESULT Logoff(
  [out, retval] IVMTask **outLogoffTask
);

Parameters

outLogoffTask [out, retval]

An IVMTask object that is used to track the completion progress of the logoff sequence.

Return value

This method can return one of these values.

Return code/value Description
S_OK
0
 The operation was successful.
DISP_E_EXCEPTION
0x80020009
 An unexpected error has occurred.
E_POINTER
0x80004003
 The parameter is NULL.
HRESULT_FROM_WIN32(ERROR_ACCESS_DENIED)
0x80070005
 The caller must have execute access permissions for this VM.
VM_E_TIMED_OUT
0xA0040202
 The operation did not complete in a timely manner.
VM_E_ADDITIONS_FEATURE_NOT_AVAIL
0xA0040505
 The integration components feature is not installed in this virtual machine.
VM_E_VM_NOT_RUNNING
0xA0040206
 The virtual machine (VM) must be running for this operation.
VM_E_VM_UNKNOWN
0xA0040207
 The configuration is unknown.

Remarks

HRESULT_FROM_WIN32(ERROR_NO_SUCH_LOGON_SESSION) (0x80070520) is returned through the Error property of the returned IVMTask object there are no logon sessions in the guest operating system.

Requirements

Requirement Value
Minimum supported client
 Windows 7 [desktop apps only]
Minimum supported server
 None supported
End of client support
 Windows 7
Product
 Windows Virtual PC
Header
VPCCOMInterfaces.h
IID
 IID_IVMGuestOS is defined as 99fea0db-4880-499a-b6d8-73dff9bc91be

See also

IVMGuestOS