Skip to main content

Volume

Volumes for the C++ Replication API

Abstract

Each OpSystem can host one or more volumes. A volume contains one or more Files.

Each OpSystem can host one or more volumes. A volume contains one or more Files.

FCREPLVolume

Class

FCREPLVolume

Represents the top level on the file system hierarchy. In the hierarchy of the Replication Manager API, it is just below OpSystem.

Getters

Getters are not applicable.

Inherited getters

Table 1. Inherited getters

Volume identification

int GetID();

OpSystem identification

Note

This is linked to the FCREPLOpSystem class.

int GetOSID();

Volume name

const char *GetName();

Volume description

const char *GetDescription();

Volume total disk space

int GetTotalDiskSpace();

Volume available disk space

int GetAvailDiskSpace();



Setters

Table 2. Setters

Volume name

void SetName(const char *name) { ((pRCESVolume)this)->SetName(name); };

Volume description

void SetDescription(const char *description) { ((pRCESVolume)this)->SetDescription(description); };



Inherited setters

Table 3. Inherited setters

Volum identification

void SetID(int id);

OpSystem identification

Note

This is linked to the FCREPLOpSystem class.

void SetOSID(int osID);

Name

void SetName(const char *name);

Description

void SetDescription(const char *description);

Volume total disk space

void SetTotalDiskSpace(int totalDiskSpace);

Volume available disk space

void SetAvailDiskSpace(int availDiskSpace);



fcReplGetVolumes

Retrieve all the volume entity objects for the given OpSystem identification.

Prototype

FCREPL_API int fcReplGetVolumes(pFCREPLConn replConn, int osID, ppFCREPLVolume *volumeList, int *volumeCount);

Parameters

Table 4. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

osID [IN]

OS identification

volumeList [OUT]

Volume entity list

volumeCount [OUT]

Number of volume entities in the list



Return

Error code

fcReplGetVolume

Retrieve the volume entity object by its name.

Prototype

FCREPL_API int fcReplGetVolume(pFCREPLConn replConn, int osID, const char *name, ppFCREPLVolume volume);

Parameters

Table 5. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

osID [IN]

OS identification

name [IN]

Hardware name

volume [OUT]

Volume entity retrieved



Return

Error code

fcReplPersistVolume

Add a volume entity to the database. If there already is a volume with the given osID/name, update the existing record.

Prototype

FCREPL_API int fcReplPersistVolume(pFCREPLConn replConn, pFCREPLVolume volume);

Parameters

Table 6. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

volume [IN]

Volume entity to be persisted



Return

Error code

fcReplRemoveVolume

Delete the volume by its identification.

Prototype

FCREPL_API int fcReplRemoveVolume(pFCREPLConn replConn, int volumeID, bool recursive);

Parameters

Table 7. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

volumeID [IN]

Volume identification

recursive [IN]

Recursive flag



Return

Error code