FsegExs Struct Reference

Parameters for FSEG_FUNC_EXS. More...

#include <FSEG.h>

Data Fields
long long	siSegInd
	[INPUT] Segment index to check.
unsigned int	isExists
	[OUTPUT] 1 if the segment exists, 0 if it does not.
unsigned int	uiRes0
	Reserved, must be set to 0.

Detailed Description

Parameters for FSEG_FUNC_EXS.

The provider sets *piRetco to 0 on success (whether or not the segment exists) and writes the existence result into isExists. A non-zero *piRetco signals an actual provider error (storage failure, I/O error, etc.) and isExists is ignored in that case.

Mapping to the FLAM layer:

• isExists == 1 and *piRetco == 0 --> FLMRTC_OK (segment found)
• isExists == 0 and *piRetco == 0 --> FLMRTC_IDX (segment not found)
• *piRetco != 0 --> FLMRTC_FSG (provider error)

Field Documentation

isExists

unsigned int FsegExs::isExists

[OUTPUT] 1 if the segment exists, 0 if it does not.

siSegInd

long long FsegExs::siSegInd

[INPUT] Segment index to check.

uiRes0

unsigned int FsegExs::uiRes0

Reserved, must be set to 0.

---

The documentation for this struct was generated from the following file:

• FSEG.h