Skip to content

iclientvirtualdeviceset2-opendevice.md

Latest commit

 

History

History
59 lines (42 loc) · 2.02 KB

iclientvirtualdeviceset2-opendevice.md

File metadata and controls

59 lines (42 loc) · 2.02 KB
title IClientVirtualDeviceSet2::OpenDevice
titlesuffix SQL Server VDI reference
description This article provides reference for the IClientVirtualDeviceSet2::OpenDevice command.
ms.date 08/30/2019
ms.prod sql
ms.prod_service backup-restore
ms.technology backup-restore
ms.topic reference
author mashamsft
ms.author mathoma

IClientVirtualDeviceSet2::OpenDevice (VDI)

[!INCLUDEappliesto-ss-xxxx-xxxx-xxx-md]

The OpenDevice function opens one of the devices in the virtual device set.

Syntax

HRESULT IClientVirtualDeviceSet2::OpenDevice (
   LPCWSTR                  lpName,
   IClientVirtualDevice**   ppVirtualDevice

);

Parameters

lpName This identifies the virtual device.

ppVirtualDevice When the function succeeds, an interface pointer to the virtual device is returned. This interface is used for the GetCommand and CompleteCommand.

Return Value

Return Value Explanation
NOERROR The function succeeded.
VD_E_ABORT Abort was requested.
VD_E_OPEN All devices are open.
VD_E_PROTOCOL The set is not in the initializing state or this particular device is already open.
VD_E_INVALID The device name is invalid. It is not one of the names known to comprise the set.

Remarks

VD_E_OPEN may be returned without problem. The client may call OpenDevice by means of a loop until this code is returned. If more than one device is configured (for example, n devices), the virtual device set will return n unique device interfaces. The first device has the same name as the virtual device set. Other devices are named as specified with the VIRTUAL_DEVICE clauses of the BACKUP/RESTORE statement.

The GetConfiguration function can be used to wait until the devices can be opened.

If this function does not succeed, then a null value is returned through the ppVirtualDevice.

Next steps

For more information, see the SQL Server virtual device interface reference overview.