IVdsMaintenance::PulseMaintenance method (vds.h)

Article
02/09/2023

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Performs the specified operation a specified number of times.

Syntax

HRESULT PulseMaintenance(
  [in] VDS_MAINTENANCE_OPERATION operation,
  [in] ULONG                     ulCount
);

Parameters

[in] operation

A maintenance operation enumerated by VDS_MAINTENANCE_OPERATION.

[in] ulCount

The number of times to perform the operation.

Return value

This method can return standard HRESULT values, such as E_INVALIDARG or E_OUTOFMEMORY, and VDS-specific return values. It can also return converted system error codes using the HRESULT_FROM_WIN32 macro. Errors can originate from VDS itself or from the underlying VDS provider that is being used. Possible return values include the following.

Return code/value	Description
S_FALSE	The specified operation is not running; the method does nothing.
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	This return value signals a software or communication problem inside a provider that caches information about the array. Use the IVdsHwProvider::Reenumerate method followed by the IVdsHwProvider::Refresh method to restore the cache.
VDS_E_OBJECT_DELETED 0x8004240BL	The subsystem object is no longer present.
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	The subsystem is in a failed state, and is unable to perform the requested operation.
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	Another operation is in progress; this operation cannot proceed until the previous operation or operations are complete.
VDS_E_NOT_SUPPORTED 0x80042400L	This operation or combination of parameters is not supported by this provider.

Remarks

If the operation is already running, this method causes it to pulse the specified number of times and then stop. The intervals at which the operation pulses is defined by the provider. This method cannot be used with the SpinDown or SpinUp operations.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	vds.h
Library	Uuid.lib