nip2pGetAttribute

int32_t nip2pGetAttribute (nip2p_tStreamHandle streamHandle, nip2p_tStreamAttribute attributeKey, void* value);

Purpose

Gets (reads) the value of a stream attribute.

Parameters

Input
Name Type Description
StreamHandle nip2p_tStreamHandle Specifies the stream from which to get (read) an attribute.
attributeKey nip2p_tStreamAttribute Specifies the attribute to read.
value void* Identifies the pointer to the object that holds the attribute value. The data type of this object must match the data type of the attribute to read.

Return Value

Name Type Description
Error code int32_t Returns the error code for the session or execution thread.

Value Meaning
0 No error.
Positive Values Warning, but the operation succeeded.
Negative Values An error occurred and the operation did not succeed.