Initial move from old twain-in-dotnet.

NTwain/Triplets/DGControl/DGControl.SetupFileXfer.cs

@@ -0,0 +1,84 @@
+// The MIT License (MIT)
+// Copyright (c) 2013 Yin-Chun Wang
+//
+// Permission is hereby granted, free of charge, to any person obtaining a 
+// copy of this software and associated documentation files (the "Software"), 
+// to deal in the Software without restriction, including without limitation 
+// the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+// and/or sell copies of the Software, and to permit persons to whom the 
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included 
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF 
+// OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+using NTwain.Data;
+using NTwain.Values;
+using System;
+
+namespace NTwain.Triplets
+{
+	public sealed class SetupFileXfer : OpBase
+	{
+		internal SetupFileXfer(TwainSession session) : base(session) { }
+		/// <summary>
+		/// Returns information about the file into which the Source has or will put the acquired image
+		/// or audio data.
+		/// </summary>
+		/// <param name="setupFileXfer">The setup file xfer.</param>
+		/// <returns></returns>
+		public ReturnCode Get(out TWSetupFileXfer setupFileXfer)
+		{
+			Session.VerifyState(4, 6, DataGroups.Control, DataArgumentType.SetupFileXfer, Message.Get);
+			setupFileXfer = new TWSetupFileXfer();
+			return PInvoke.DsmEntry(Session.AppId, Session.SourceId, Message.Get, setupFileXfer);
+		}
+
+		/// <summary>
+		/// Returns information for the default image or audio file.
+		/// </summary>
+		/// <param name="setupFileXfer">The setup file xfer.</param>
+		/// <returns></returns>
+		public ReturnCode GetDefault(out TWSetupFileXfer setupFileXfer)
+		{
+			Session.VerifyState(4, 6, DataGroups.Control, DataArgumentType.SetupFileXfer, Message.GetDefault);
+			setupFileXfer = new TWSetupFileXfer();
+			return PInvoke.DsmEntry(Session.AppId, Session.SourceId, Message.GetDefault, setupFileXfer);
+		}
+
+		/// <summary>
+		/// Resets the current file information to the image or audio default file information and
+		/// returns that default information.
+		/// </summary>
+		/// <param name="setupFileXfer">The setup file xfer.</param>
+		/// <returns></returns>
+		public ReturnCode Reset(out TWSetupFileXfer setupFileXfer)
+		{
+			Session.VerifyState(4, 4, DataGroups.Control, DataArgumentType.SetupFileXfer, Message.Reset);
+			setupFileXfer = new TWSetupFileXfer();
+			return PInvoke.DsmEntry(Session.AppId, Session.SourceId, Message.Reset, setupFileXfer);
+		}
+
+		/// <summary>
+		/// Sets the file transfer information for the next file transfer. The application is responsible for
+		/// verifying that the specified file name is valid and that the file either does not currently exist (in
+		/// which case, the Source is to create the file), or that the existing file is available for opening and
+		/// read/write operations. The application should also assure that the file format it is requesting
+		/// can be provided by the Source
+		/// </summary>
+		/// <param name="setupFileXfer">The setup file xfer.</param>
+		/// <returns></returns>
+		public ReturnCode Set(TWSetupFileXfer setupFileXfer)
+		{
+			Session.VerifyState(4, 6, DataGroups.Control, DataArgumentType.SetupFileXfer, Message.Set);
+			return PInvoke.DsmEntry(Session.AppId, Session.SourceId, Message.Set, setupFileXfer);
+		}
+
+	}
+}