GEV_STATUS GevGetLibraryConfigOptions(GEVLIB_CONFIG_OPTIONS *options);
GEV_STATUS GevSetLibraryConfigOptions(GEVLIB_CONFIG_OPTIONS *options);

Description

Obtains or updates the user configurable parameters that apply to the GigE-V Framework API library. The configurable options are contained in a data structure of type GEVLIB_CONFIG_OPTIONS and apply globally to the operation of the GigE-V Framework API library within the current application.

Parameters

options

Pointer to a GEVLIB_CONFIG_OPTIONS structure:

typedef struct

{
    UINT32 version;
    UINT32 logLevel;
    UINT32 numRetries;
    UINT32 command_timeout_ms;
    UINT32 discovery_timeout_ms;
    UINT32 enumeration_port;
    UINT32 gvcp_port_range_start;
    UINT32 gvcp_port_range_end;
    UINT32 manual_xml_handling;
} GEVLIB_CONFIG_OPTIONS, *PGEVLIB_CONFIG_OPTIONS;

 

 

 

Structure Description

 

 

version

The version of the API (it is read-only)

 

logLevel

The current message severity logging level for informational messages. The logLevel can be set to select which messages are actually output. Possible values are:

 

 

 

GEV_LOG_LEVEL_OFF

No logging is performed

GEV_LOG_LEVEL_NORMAL

Fatal and error messages are enabled

GEV_LOG_LEVEL_ERRORS

Same as “NORMAL”

GEV_LOG_LEVEL_WARNINGS

Warning messages are also enabled

GEV_LOG_LEVEL_DEBUG

Debug messages are also enabled

GEV_LOG_LEVEL_TRACE

Trace messages are also enabled

 

 

The default value is GEV_LOG_LEVEL_NORMAL.

 

 

Messages are logged using GevPrint to print messages.
Messages can have the following levels of severity :

 

 

GEV_LOG_FATAL

For fatal errors.

GEV_LOG_ERROR

For general errors.

GEV_LOG_WARNING

For warnings

GEV_LOG_INFO

For informational purposes

 

 

Important: The more types of messages that are enabled, the more of a load is placed on the library to perform the logging. This can lead to degradation of performance in high data rate applications.

 

numRetries

Number of times a command is retried before giving up on the command and generating an error. This is to allow some tolerance for collisions and added traffic on the network interface connecting the PC to the camera. (The default value is 3)

 

command_timeout_ms

Milliseconds the library will wait for a response to a command before attempting to retry the command or, if the number of retries have been exhausted, failing the command.
(The default value is 2000 msecs)

 

discovery_timeout_ms

Milliseconds the library will wait for a response when querying the network for the presence of cameras. The number of retries setting also applies to the process of querying the presence of cameras. (The default value is 1000 msecs)

 

enumeration_port

IP (Internet Protocol) port on which the device enumeration/discovery will take place. This allows for the tuning of network port usage in a system. (The default value is 39999)

 

gvcp_port_range_start
gvcp_port_range_end

Start and end IP (Internet Protocol) port numbers for the range of ports used by the library for communicating with cameras. Port assignments are taken as needed, from this range and returned when they are no longer required. This allows for the tuning of network port usage in a system.
(The default range is 40000 to 49999)

 

manual_xml_handling

Flag to turn off automatic setup of XML features when a camera is opened. XML feature access must be performed manually if this is 1 (true).

Return Value

GEVLIB_OK

Related Topics

Member Function Descriptions