Share via


FbwfGetVolumeList

5/10/2007

Retrieves the list of protected volumes for either the current or next session.

Syntax

ULONG FbwfGetVolumeList(
   ULONG currentSession,
   PVOID volumeList,
   PULONG size
);

Parameters

  • currentSession
    [in] Boolean value. If true, the list of protected volumes in the current session will be returned, otherwise the function will return the list of volumes to be protected in the next session.
  • volumeList
    [out] Caller allocated buffer receiving the volume list as a multi-string.
  • size
    [in, out] Size of the buffer pointed to by volumeList. If this buffer size is too small, the function will fail and size will contain the required buffer size.

Return Value

This function may return the following:

Return value Description

NO_ERROR

The operation completed successfully.

ERROR_INVALID_PARAMETER

If the volumeList or size parameter is NULL.

ERROR_MORE_DATA

If the volumeList buffer is too small, in which case size will point to a ULONG containing the required buffer size.

Requirements

OS Versions: Windows XP Embedded, WEPOS.

Header: fbwfapi.h.

Link Library: fbwflib.lib.

See Also

Reference

FbwfProtectVolume
FbwfUnprotectVolume
FbwfIsVolumeProtected

Concepts

FBWF API