ShellDataObjectFormatGetStream Method (Object, String, NullableInt32, Boolean, Boolean)

Gets a stream from an IDataObject.

Namespace: ShellBoost.Core
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0

Syntax

public static Stream GetStream(
	Object dataObject,
	string format,
	int? index = null,
	bool useChunkedMemoryStream = true,
	bool throwOnError = true
)

Parameters

dataObject: Type: SystemObject
The data object.
format: Type: SystemString
The format.
index (Optional): Type: SystemNullableInt32
An optional index filter.
useChunkedMemoryStream (Optional): Type: SystemBoolean
if set to true use the ChunkedMemoryStream class instead of the MemoryStream class.
throwOnError (Optional): Type: SystemBoolean
if set to true errors may be throw in case of Windows Shell errors.

Return Value

Type: Stream
0 or an error code.

Exceptions

Exception	Condition
ArgumentException	dataObject is null or invalid.

Reference

ShellDataObjectFormat Class

GetStream Overload

ShellBoost.Core Namespace

ShellBoost Core Documentation

Parameters

Return Value

Reference