Function libCZI_CreateInputStream

Function libCZI_CreateInputStream#

Function Documentation#

LibCZIApiErrorCode libCZI_CreateInputStream(const char *stream_class_name, const char *creation_property_bag, const char *stream_identifier, InputStreamObjectHandle *stream_object)#

Create an input stream object of the specified type, using the specified JSON-formatted property bag and the specified file identifier as input.

Parameters:

  • stream_class_name – Name of the stream class to be instantiated.

  • creation_property_bag – JSON formatted string (containing additional parameters for the stream creation) in UTF8-encoding.

  • stream_identifier – The filename (or, more generally, a URI of some sort) identifying the file to be opened in UTF8-encoding.

  • stream_object – [out] If successful, a handle representing the newly created stream object is put here.

Returns:

An error-code that indicates whether the operation is successful or not.

Contents