ntwain/NTwain/Triplets/DGControl/DGControl.PendingXfers.cs

using NTwain.Data;
using NTwain.Internals;

namespace NTwain.Triplets
{
    /// <summary>
    /// Represents <see cref="DataArgumentType.PendingXfers"/>.
    /// </summary>
	sealed class PendingXfers : OpBase
	{
		internal PendingXfers(ITwainSessionInternal session) : base(session) { }
		/// <summary>
		/// This triplet is used to cancel or terminate a transfer. Issued in state 6, this triplet cancels the next
		/// pending transfer, discards the transfer data, and decrements the pending transfers count. In
		/// state 7, this triplet terminates the current transfer. If any data has not been transferred (this is
		/// only possible during a memory transfer) that data is discarded.
		/// </summary>
		/// <param name="pendingXfers">The pending xfers.</param>
		/// <returns></returns>
		internal ReturnCode EndXfer(TWPendingXfers pendingXfers)
		{
			Session.VerifyState(6, 7, DataGroups.Control, DataArgumentType.PendingXfers, Message.EndXfer);
			return Dsm.DsmEntry(Session.AppId, Session.SourceId, Message.EndXfer, pendingXfers);
		}

		/// <summary>
		/// Returns the number of transfers the Source is ready to supply to the application, upon demand.
		/// If DAT_XFERGROUP is set to DG_Image, this is the number of images. If DAT_XFERGROUP is set
		/// to DG_AUDIO, this is the number of audio snippets for the current image. If there is no current
		/// image, this call must return Failure / SeqError.
		/// </summary>
		/// <param name="pendingXfers">The pending xfers.</param>
		/// <returns></returns>
		public ReturnCode Get(TWPendingXfers pendingXfers)
		{
			Session.VerifyState(4, 7, DataGroups.Control, DataArgumentType.PendingXfers, Message.Get);
			return Dsm.DsmEntry(Session.AppId, Session.SourceId, Message.Get, pendingXfers);
		}

		/// <summary>
		/// Sets the number of pending transfers in the Source to zero.
		/// </summary>
		/// <param name="pendingXfers">The pending xfers.</param>
		/// <returns></returns>
		internal ReturnCode Reset(TWPendingXfers pendingXfers)
		{
			Session.VerifyState(6, 6, DataGroups.Control, DataArgumentType.PendingXfers, Message.Reset);
			return Dsm.DsmEntry(Session.AppId, Session.SourceId, Message.Reset, pendingXfers);
		}

		/// <summary>
		/// If CapAutoScan is TRUE, this command will stop the operation of the scanner’s automatic
		/// feeder. No other action is taken.
		/// </summary>
		/// <param name="pendingXfers">The pending xfers.</param>
		/// <returns></returns>
		public ReturnCode StopFeeder(TWPendingXfers pendingXfers)
		{
			Session.VerifyState(6, 6, DataGroups.Control, DataArgumentType.PendingXfers, Message.StopFeeder);
			return Dsm.DsmEntry(Session.AppId, Session.SourceId, Message.StopFeeder, pendingXfers);
		}
	}
}