SpiCreateStream - Parameters

hidSrc (HID) - input

Source stream handler ID.

hidTgt (HID) - input

Target stream handler ID.

pspcbkey (PSPCBKEY) - input

Data type (subtype) to be streamed.

pdcbSrc (PDCB) - input

Pointer to the device control block that contains device-specific instance information about the source device. This field must be NULL for stream handlers that do not support a DCB.

pdcbTgt (PDCB) - input

Pointer to device control block that contains device-specific instance information about the target device. This field must be NULL for stream handlers that do not support a DCB.

pevcb (PIMPL_EVCB) - input

Structure is filled in during event notification. The structure must be allocated statically and can not be a local variable.

EventEntry (PEVFN) - input

Entry point of a routine to handle stream events. This routine is called whenever an event is reported to or generated by the Sync/Stream Manager. All events reported are serialized; therefore, it is advantageous to keep the event routine as small as possible. Some SPI functions can be called from within an event routine. SpiDestroyStream should not be issued from within the event routine.

hstreamBuf (HSTREAM) - input

If the stream protocol for this stream instance specifies that the stream is a split stream, then this field indicates which stream instance has allocated buffers that this stream will use. In this case, the Sync/Stream Manager does not allocate a new set of stream buffers for this stream. If this stream instance is not a split stream, the Sync/Stream Manager ignores this field, but it will be passed to the source and target stream handlers.

phstream (PHSTREAM) - output

Address for handle of newly created stream.

phevent (PHEVENT) - output

Implicit event handle.

rc (ULONG) - returns

Return codes indicating success or the type of failure:

NO_ERROR

Success.
ERROR_INVALID_BLOCK
Invalid pointer.
ERROR_INVALID_BUFFER_SIZE
Invalid DCB size.
ERROR_INVALID_FUNCTION
Invalid function requested.
ERROR_INVALID_STREAM
Invalid stream handle.
ERROR_INVALID_PARAMETER
Invalid parameter.
ERROR_INVALID_PROTOCOL
An error occurred while negotiating the stream protocol for this stream instance.
ERROR_INVALID_HID
Invalid handler ID.
ERROR_INVALID_SPCBKEY
Invalid pspcbkey. The stream type is unknown or the stream handlers specified cannot stream this type.
ERROR_DEVICE_NOT_FOUND
Invalid device-driver name.
ERROR_ALLOC_HEAP
An error occurred while allocating the resources needed to set up this stream. The heap can be adjusted to a bigger size on the DEVICE= statement for the Sync/Stream Manager device driver. See Performance Tuning the Sync/Stream Manager in the OS/2 Multimedia Subsystem Programming Guide.
ERROR_NOT_ENOUGH_MEMORY
There is not enough memory to allocate the minimum number of buffers to sustain this stream instance.
ERROR_TOO_MANY_STREAMS
Too many streams have been created. The number of streams can be adjusted to a bigger size on the DEVICE statement for the Sync/Stream Manager device driver. See Performance Tuning the Sync/Stream Manager in the OS/2 Multimedia Subsystem Programming Guide.
FAILURE
Stream handler-specific error return code.

---

[Back: SpiCreateStream Return Value - rc]
[Next: SpiCreateStream - Remarks]