Browse
 
Tools
Rss Categories

LV_SRE_StreamGetParameter

Reference Number: AA-00728 Views: 1994 0 Rating/ Voters

Gets the current value of a stream property.

Function

  • int LV_SRE_StreamGetParameter(HPORT hport, const char* StreamParameter, unsigned int* StreamParameterValue)
 

Parameters

hport

The port's handle.

StreamParameter

The stream property to view its current value. See available Stream Properties.

Version 10.5
Note that in version 10.5, this parameter changed from an int to a const char *, which was to optimize the code internally. This should have minimal effect on users, except to require a recompilation of any code linking to the API when making this transition.  Specifically, the defines that can be used in this parameter value were changed in the definition to accommodate this.

StreamParameterValue

A container to hold the current value of the Property.

Return Values

LV_SUCCESS

No Errors and the value was stored in StreamParameterValue.

LV_INVALID_PROPERTY

The specified parameter does not exist.

LV_INVALID_PORT

The input hport is not a valid one.

LV_FAILURE

The operation failed because the port was shutting down.

LV_EXCEPTION

An exception occurred while processing the request.

See Also