CogSerializer.SaveObjectToStream Method (Object, Stream, Type, CogSerializationOptionsConstants, StreamingContextStates)

CogSerializer SaveObjectToStream Method (Object, Stream, Type, CogSerializationOptionsConstants, StreamingContextStates)

Cognex VisionPro 9.20

Saves an object to a stream in a specified format, with option bits that cause fields to be selectively persisted.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 80.0.0.0

Syntax

C++

Copy to Clipboard Print

public static void SaveObjectToStream(
	Object obj,
	Stream stream,
	Type formatterType,
	CogSerializationOptionsConstants optionBits,
	StreamingContextStates contextStates
)

public static void SaveObjectToStream(
	Object obj,
	Stream stream,
	Type formatterType,
	CogSerializationOptionsConstants optionBits,
	StreamingContextStates contextStates
)

Public Shared Sub SaveObjectToStream ( 
	obj As Object,
	stream As Stream,
	formatterType As Type,
	optionBits As CogSerializationOptionsConstants,
	contextStates As StreamingContextStates
)

Public Shared Sub SaveObjectToStream ( 
	obj As Object,
	stream As Stream,
	formatterType As Type,
	optionBits As CogSerializationOptionsConstants,
	contextStates As StreamingContextStates
)

public:
static void SaveObjectToStream(
	Object^ obj, 
	Stream^ stream, 
	Type^ formatterType, 
	CogSerializationOptionsConstants optionBits, 
	StreamingContextStates contextStates
)

public:
static void SaveObjectToStream(
	Object^ obj, 
	Stream^ stream, 
	Type^ formatterType, 
	CogSerializationOptionsConstants optionBits, 
	StreamingContextStates contextStates
)

Parameters

obj: Type: System Object
The object to save.

stream: Type: System.IO Stream
The output stream.

formatterType: Type: System Type
The type of formatter to use. You may use either a BinaryFormatter (to save the object as binary data) or a SoapFormatter (to save the object as XML text). For example, to use the SoapFormatter in C# you would type: typeof(System.Runtime.Serialization.Formatters.Soap.SoapFormatter)

optionBits: Type: Cognex.VisionPro CogSerializationOptionsConstants
The option bits specifying what should be persisted.

contextStates: Type: System.Runtime.Serialization StreamingContextStates
The context states specify the intended purpose of persisting. In particular, users should be aware that if the StreamingContextState.Persistence flag is set on save, any serialized VisionPro .NET objects will reset their HasChanged property to false.

Remarks

To learn more about persisting objects, see Persistence in VisionPro