This function gets the StreamInfo of each stream in the given streamset.
Namespace: VcClient.TestAssembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)
Syntax
| C# |
|---|
public virtual List<StreamInfo> GetStreamSetInfo(
string url,
bool compression,
string key,
string value,
bool sparseStreamSet
) |
| Visual Basic |
|---|
Public Overridable Function GetStreamSetInfo ( _
url As String, _
compression As Boolean, _
key As String, _
value As String, _
sparseStreamSet As Boolean _
) As List(Of StreamInfo) |
| Visual C++ |
|---|
public:
virtual List<StreamInfo^>^ GetStreamSetInfo(
String^ url,
bool compression,
String^ key,
String^ value,
bool sparseStreamSet
) |
Parameters
- url
- Type: String
The base url of the streamSet for whose stream the StreamInfo is needed.
- compression
- Type: Boolean
Whether compression should be used while communicating with the VC.
- key
- Type: String
The key that needs to be appended to the stream set url.
- value
- Type: String
The value that needs to be appended to the stream set for the key.
- sparseStreamSet
- Type: Boolean
Passing true means that the stream set is sparse and passing false means that
the stream set is not sparse.
Return Value
A list of StreamInfo objects corresponding to each stream in the stream set.
Exceptions
| Exception | Condition |
|---|
| ArgumentOutOfRangeException | key is not null and not
'date' or 'hour' or 'serialnum'). |
| ArgumentException | Either url or value is
null or empty or contains whitespace only, though key was specified. |
| ArgumentNullException | url is null. |
See Also
