Get Transfer Progress Information.

Namespace:  GrassValley.Mseries.TransferQueue
Assembly:  GrassValley.Mseries.TransferQueue (in GrassValley.Mseries.TransferQueue.dll) Version: 1.0.0.0

Syntax

C#
void GetProgressInfo(
	int token,
	out int nXfrState,
	out int hrInternal,
	out ulong nTotalBytes,
	out ulong nCurBytes,
	out ulong nTotalFields,
	out ulong nCurFields,
	out int nAveRate,
	out int nLastRate
)
Visual Basic (Declaration)
Sub GetProgressInfo ( _
	token As Integer, _
	<OutAttribute> ByRef nXfrState As Integer, _
	<OutAttribute> ByRef hrInternal As Integer, _
	<OutAttribute> ByRef nTotalBytes As ULong, _
	<OutAttribute> ByRef nCurBytes As ULong, _
	<OutAttribute> ByRef nTotalFields As ULong, _
	<OutAttribute> ByRef nCurFields As ULong, _
	<OutAttribute> ByRef nAveRate As Integer, _
	<OutAttribute> ByRef nLastRate As Integer _
)
Visual C++
void GetProgressInfo(
	int token, 
	[OutAttribute] int% nXfrState, 
	[OutAttribute] int% hrInternal, 
	[OutAttribute] unsigned long long% nTotalBytes, 
	[OutAttribute] unsigned long long% nCurBytes, 
	[OutAttribute] unsigned long long% nTotalFields, 
	[OutAttribute] unsigned long long% nCurFields, 
	[OutAttribute] int% nAveRate, 
	[OutAttribute] int% nLastRate
)

Parameters

token
Type: System..::.Int32
Token.
nXfrState
Type: System..::.Int32 %
Transfer State.
hrInternal
Type: System..::.Int32 %

[Missing <param name="hrInternal"/> documentation for "M:GrassValley.Mseries.TransferQueue.IXfrQueue2.GetProgressInfo(System.Int32,System.Int32@,System.Int32@,System.UInt64@,System.UInt64@,System.UInt64@,System.UInt64@,System.Int32@,System.Int32@)"]

nTotalBytes
Type: System..::.UInt64 %
Total Bytes Need to Transfer.
nCurBytes
Type: System..::.UInt64 %
Bytes have been transferred.
nTotalFields
Type: System..::.UInt64 %
Total Fields Need to Transfer.
nCurFields
Type: System..::.UInt64 %
Fields have been transferred.
nAveRate
Type: System..::.Int32 %
Average Transfer Rate.
nLastRate
Type: System..::.Int32 %
Most Recent Transfer Rate.

See Also