global_get_option()
Info | Value |
---|---|
Package | mvnc |
Module | mvncapi |
Version | 2.0 |
See also | GlobalOption, global_set_option() |
Overview
This function returns the value of a global option. The available options and possible values can be found in the GlobalOption enumeration.
Syntax
value = mvncapi.global_get_option(option)
Parameters
Parameter | Type | Description |
---|---|---|
option | int | A member of the GlobalOption enumeration that specifies which option value to get. |
Return
value
The value for the specified option. The value type depends on the option specified. See the GlobalOption enumeration for the type that corresponds to each option.
Raises
Exception with a Status.INVALID_PARAMETERS code if an invalid option is passed or Exception with a status code from Status if underlying function calls return a status other than Status.OK.
Notes
None.
Example
from mvnc import mvncapi
# Print the API version
print('NCAPI Version:', mvncapi.global_get_option(mvncapi.GlobalOption.RO_API_VERSION))