IVMGuestOS::TerminalServerPort property
[Windows Virtual PC is no longer available for use as of Windows 8. Instead, use the Hyper-V WMI provider (V2).]
Port used by Remote Desktop Services (formerly known as Terminal Services) in the guest operating system.
This property is read-only.
Syntax
HRESULT get_TerminalServerPort(
[out, retval] long *tsPort = 3389
);
Property value
Returns the port used by Remote Desktop Services in the guest operating system.
Value | Meaning |
---|---|
|
Default value |
|
Valid range |
|
Valid port value is not available. |
Error codes
Name/value | Meaning |
---|---|
|
The operation was successful. |
|
Remote Desktop Services is not yet initialized in the guest operating system. |
|
The tsPort parameter is NULL. |
|
The virtual machine is not running. |
|
Integration components are not installed in this virtual machine. |
|
An unexpected error has occurred. |
Remarks
The value of this property is not valid unless the TerminalServicesInitialized property is VARIANT_TRUE.
If the TerminalServicesInitialized property is VARIANT_FALSE due to a connection error on the port, then the value returned by the TerminalServerPort property contains the error value.
Requirements
Requirement | Value |
---|---|
Minimum supported client |
Windows 7 [desktop apps only] |
Minimum supported server |
None supported |
End of client support |
Windows 7 |
IDL |
|
IID |
IID_IVMGuestOS is defined as 99fea0db-4880-499a-b6d8-73dff9bc91be |