Class ComEnumFORMATETC
Class thet represents the enum formatec class.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.CompoundFile.DocIO.Native
Assembly: Syncfusion.DocIO.Base.dll
Syntax
[CLSCompliant(false)]
[ComVisible(true)]
public class ComEnumFORMATETC : ArrayList, IList, ICollection, IEnumerable, ICloneable, IComEnumFORMATETC
Constructors
ComEnumFORMATETC()
Declaration
public ComEnumFORMATETC()
Methods
Clone(ref IComEnumFORMATETC)
Creates another connection point enumerator with the same state as the current enumerator to iterate over the same list.
Declaration
public uint Clone(ref IComEnumFORMATETC ppenum)
Parameters
Type | Name | Description |
---|---|---|
Syncfusion.CompoundFile.DocIO.Native.IComEnumFORMATETC | ppenum | Pointer to the returned IComEnumFORMATETC interface. |
Returns
Type | Description |
---|---|
System.UInt32 | This method supports the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED. |
RemoteNext(UInt32, ref FORMATETC, ref UInt32)
The RemoteNext method retrieves a specified number of HRESULT structures.
Declaration
public uint RemoteNext(uint celt, ref FORMATETC rgelt, ref uint pceltFetched)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | celt | The number of STATSTG structures requested. |
FORMATETC | rgelt | An array of STATSTG structures returned. |
System.UInt32 | pceltFetched | The number of STATSTG structures retrieved in the rgelt parameter. |
Returns
Type | Description |
---|---|
System.UInt32 | S_OK - The number of STATSTG structures returned equals the number specified in the celt parameter. Otherwise - error code. |
Reset()
Resets the enumeration sequence to the beginning.
Declaration
public uint Reset()
Returns
Type | Description |
---|---|
System.UInt32 | S_OK |
Skip(UInt32)
Instructs the enumerator to skip the next celt elements in the enumeration so that the next call to IEnumConnectionPoints::Next will not return those elements.
Declaration
public uint Skip(uint celt)
Parameters
Type | Name | Description |
---|---|---|
System.UInt32 | celt | Number of elements to be skipped. |
Returns
Type | Description |
---|---|
System.UInt32 | S_OK if the number of elements skipped is celt; otherwise, S_FALSE. |