ScanFix Xpress v9.0 for .NET - Updated
ReadFromStream Method




Accusoft.ScanFixXpressSdk Namespace > Enhancements Class : ReadFromStream Method
A stream that the WriteToStream method created.
An instance of the ScanFix component
Reads a specially-formatted stream and places the values into properties of this object.
Syntax
'Declaration
 
Public Sub ReadFromStream( _
   ByVal stream As String, _
   ByVal sf As ScanFix _
) 
'Usage
 
Dim instance As Enhancements
Dim stream As String
Dim sf As ScanFix
 
instance.ReadFromStream(stream, sf)
public void ReadFromStream( 
   string stream,
   ScanFix sf
)
public: void ReadFromStream( 
   string* stream,
   ScanFix* sf
) 
public:
void ReadFromStream( 
   String^ stream,
   ScanFix^ sf
) 

Parameters

stream
A stream that the WriteToStream method created.
sf
An instance of the ScanFix component
Exceptions
ExceptionDescription
Thrown when sf parameter is null
Remarks

This method reads a stream, which contains the values of properties for this object. It provides a convenient way to store and retrieve the values and preserves as much future compatibility as possible.

This method should read any stream that the WriteToStream method created, even if an older version of this toolkit created it. This method will fail to read a stream that a newer version of this toolkit created.

Note: You should retrieve the value for the stream from the Operations property of a FormDirector FormSet object. When the Type property of that object is "ScanFix/Enhancement", the Content property contains a string that you should send to this method.

The properties that this method reads from the stream are:

See Also

Reference

Enhancements Class
Enhancements Members
WriteToStream Method

Is this page helpful?
Yes No
Thanks for your feedback.