IVMVirtualServer::VMRCEncryptionCertificate property

  • Article

The VMRCEncryptionCertificate property contains the security certificate used by SSL/TLS encryption to protect VMRC session data.

This property is read/write.

Syntax

HRESULT put_VMRCEncryptionCertificate(
  [in]  BSTR certificate
);

HRESULT get_VMRCEncryptionCertificate(
  [out] BSTR *certificate
);

VB 
VMVirtualServer.VMRCEncryptionCertificate( _
  ByRef certificate, _
  ByVal certificate _
)

Property value

The Base-64 encoded security certificate used by SSL/TLS encryption to protected session data. A zero-length string indicates that no security certificate will be used and the VMRC session cannot be protected by encryption.

This property value is read/write.

Error codes

Name Meaning
S_OK
 The operation was successful.
E_POINTER
 The parameter certificate referenced is NULL.
E_INVALIDARG
 The parameter certificate contains an invalid security certificate.
DISP_E_EXCEPTION
 An unexpected error occurred.

Remarks

When this property is set to a zero-length string, it indicates that no security certificate is in use. In this case, VMRC sessions cannot be protected.

The private key referenced by the security certificate must already exist on the computer on which Virtual Server is running.

Examples

The following example displays the VMRCEncryptionCertificate property value of the VMVirtualServer object.

Set objVS = CreateObject("VirtualServer.Application")

Wscript.Echo "Name: " & objVS.Name
If objVS.VMRCEncryptionCertificate = "" Then
  Wscript.Echo "VMRC encryption certificate: [none]"
Else
  Wscript.Echo "VMRC encryption certificate: " & _
                objVS.VMRCEncryptionCertificate
End If

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