SaveSettings(Stream,Boolean) Method (Device)

In This Topic

Saves the current device settings to the stream.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Overloads Sub SaveSettings( _
   ByVal streamStream to save the device settings.
 As System.IO.Stream, _
   ByVal checkIfCustomDsDataSupportedA value indicating whether device needs to check that CustomDsData capability is supported.
 As Boolean _
)

public void SaveSettings(
   System.IO.Stream stream, 
   bool checkIfCustomDsDataSupported
)

public: void SaveSettings(
   System.IO.Stream* stream, 
   bool checkIfCustomDsDataSupported
)

public:
void SaveSettings(
   System.IO.Stream^ stream, 
   bool checkIfCustomDsDataSupported
)

Parameters

stream: Stream to save the device settings.
checkIfCustomDsDataSupported: A value indicating whether device needs to check that CustomDsData capability is supported.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown if stream is null.
System.ArgumentException	Thrown if stream does not have write access.
TwainInvalidStateException	Thrown if device is in wrong state.
TwainDeviceCapabilityException	Thrown if device does not support profiles with settings.
DebuggerException	Thrown if the .NET debugger is used and the function evaluation requires all threads to run.

Remarks

Call this method only when device is opened (State == DeviceState.Opened).

Example

This C#/VB.NET code shows how to save the current device settings to a file.

VB.NET


Public Sub SaveSettings(device As Vintasoft.Twain.Device)
        device.Open()
        Using fs As New System.IO.FileStream("scanner-setup.xml", System.IO.FileMode.Append, System.IO.FileAccess.Write)
                device.SaveSettings(fs)
        End Using
End Sub


public void SaveSettings(Vintasoft.Twain.Device device)
{
    device.Open();
    using (System.IO.FileStream fs = new System.IO.FileStream("scanner-setup.xml", System.IO.FileMode.Append, System.IO.FileAccess.Write))
    {
        device.SaveSettings(fs);
    }
}

Requirements

Target Platforms: .NET 9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

Device Class
Device Members

LoadSettings(Stream)
Overload List

Send Feedback