DfsFile.ReadItemTimeStep Method (IDfsItemData, Int32)

DfsFileReadItemTimeStep Method (IDfsItemData, Int32)

Read the specified item and time step. With this you can reuse the data buffer in IDfsItemData, Data. The data is updated in place.

If the data from a timestep is to be stored, the user is responsible to copy the data before using this method again.

The itemData must origin from the dfs file at hand, either returned by another ReadItemTimeStep call, or by use of a

Copy

CreateEmptyItemData

method.

Namespace: DHI.Generic.MikeZero.DFS
Assembly: DHI.Generic.MikeZero.DFS (in DHI.Generic.MikeZero.DFS.dll) Version: 16.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public bool ReadItemTimeStep(
	IDfsItemData itemData,
	int timestepIndex
)

Public Function ReadItemTimeStep ( 
	itemData As IDfsItemData,
	timestepIndex As Integer
) As Boolean

public:
virtual bool ReadItemTimeStep(
	IDfsItemData^ itemData, 
	int timestepIndex
) sealed

abstract ReadItemTimeStep : 
        itemData : IDfsItemData * 
        timestepIndex : int -> bool 
override ReadItemTimeStep : 
        itemData : IDfsItemData * 
        timestepIndex : int -> bool

Parameters

itemData: Type: DHI.Generic.MikeZero.DFSIDfsItemData
timestepIndex: Type: SystemInt32

Return Value

Type: Boolean
true on succes, false on end of file

Implements

IDfsFileIOReadItemTimeStep(IDfsItemData, Int32)

Reference

DfsFile Class

ReadItemTimeStep Overload

DHI.Generic.MikeZero.DFS Namespace