Sets a streaming property to its default value.
Function
- int LV_SRE_StreamSetParameterToDefault(HPORT hport, const char* StreamParameter)
Parameters
hport
The port's handle.
StreamParameter
The stream parameter to reset to default. 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.
Return Values
LV_SUCCESS
No errors; parameter changed correctly.
LV_INVALID_PROPERTY
The specified parameter does not exist.
LV_INVALID_HPORT
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
