Gets the StreamInfo for a stream.

Namespace: VcClient
Assembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)

Syntax

C#
public static StreamInfo GetStreamInfo(
	string stream,
	bool compression,
	bool allowIncompleteStream
)
Visual Basic
Public Shared Function GetStreamInfo ( _
	stream As String, _
	compression As Boolean, _
	allowIncompleteStream As Boolean _
) As StreamInfo
Visual C++
public:
static StreamInfo^ GetStreamInfo(
	String^ stream, 
	bool compression, 
	bool allowIncompleteStream
)

Parameters

stream
Type: String
The stream for which the StreamInfo is required.
compression
Type: Boolean
Whether compression should be used while communicating with the VC.
allowIncompleteStream
Type: Boolean
Allow incomplete streams to be returned. If this is set to false and the stream is incomplete, the function will throw a VcClientException. A stream is considered incomplete if it is pending geo-replication or cross volume copy is in progress.

Return Value

StreamInfo object containing the information about the stream.

See Also