Interface IEnumSTATSTG
The IEnumSTATSTG interface enumerates an array of STATSTG structures. These structures contain statistical data about open storage, stream, or byte array objects. IEnumSTATSTG has the same methods as all enumerator interfaces: Next, Skip, Reset, and Clone.
Namespace: Syncfusion.CompoundFile.DocIO.Native
Assembly: Syncfusion.DocIO.UWP.dll
Syntax
public interface IEnumSTATSTGMethods
Clone(ref IEnumSTATSTG)
The Clone method creates a new enumerator that contains the same enumeration state as the current STATSTG structure enumerator. Using this method, a client can record a particular point in the enumeration sequence and then return to that point at a later time. The new enumerator supports the same IEnumSTATSTG interface.
Declaration
int Clone(ref IEnumSTATSTG ppenum)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumSTATSTG | ppenum | A pointer to the variable that receives the IEnumSTATSTG interface pointer. If the method is unsuccessful, the value of the ppenum parameter is undefined. |
Returns
| Type | Description |
|---|---|
| System.Int32 | E_INVALIDARG - The ppenum parameter is NULL. E_OUTOFMEMORY - Insufficient memory. E_UNEXPECTED - An unexpected exception occurred. |
Next(UInt32, ref STATSTG, ref UInt32)
The Next method retrieves a specified number of STATSTG structures, that follow subsequently in the enumeration sequence. If there are fewer than the requested number of STATSTG structures left in the enumeration sequence, it retrieves the remaining STATSTG structures.
Declaration
int Next(uint celt, ref STATSTG rgelt, ref uint pceltFetched)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | celt | The number of STATSTG structures requested. |
| STATSTG | rgelt | An array of STATSTG structures returned. |
| System.UInt32 | pceltFetched | The number of STATSTG structures retrieved in the rgelt parameter. |
Returns
| Type | Description |
|---|---|
| System.Int32 | S_OK - The number of STATSTG structures returned equals the number specified in the celt parameter. S_FALSE - The number of STATSTG structures returned is less than the number specified in the celt parameter. |
Reset()
The Reset method resets the enumeration sequence to the beginning of the STATSTG structure array.
Declaration
int Reset()Returns
| Type | Description |
|---|---|
| System.Int32 | S_OK - The enumeration sequence was successfully reset to the beginning of the enumeration. |
Skip(UInt32)
The Skip method skips a specified number of STATSTG structures in the enumeration sequence.
Declaration
int Skip(uint celt)Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | celt | The number of STATSTG structures to skip. |
Returns
| Type | Description |
|---|---|
| System.Int32 | S_OK - The specified number of STATSTG structures were successfully skipped. S_FALSE - The number of STATSTG structures skipped is less than the celt parameter. |