user_device_set_max_device_domain_count()

Defines the maximum number of domains for a device.

You can find the template for this subroutine in:

usrtm_maxdom.c

Syntax

void user_device_set_max_device_domain(DEVICE_DATA *device_struct,

                                       int * max_domains_allowed,

                                       int *comm_status,

                                       int *status);

Input Parameters

device_struct

Is a pointer to the structure defining device data. DEVICE_DATA is a typedef to a structure defined in <inc_path/toolkit.h>.

Output Parameters

max_num_domains_allowed

Defines the maximum number of device domains that can be configured.  Valid values are between 1 and 16384 although practical limitations including due to size and/or performance may impose a lessor upper limit.

comm_status

Indicates whether a status of TOOLKIT_FAILURE occurred as a result of a communication failure.

Valid values are:

TOOLKIT_SUCCESS Failure is not due to communications failure.
TOOLKIT_FAILURE Failure is due to communications failure.

status

Indicates whether the function successfully obtained all of the requested information. Valid values are:

TOOLKIT_SUCCESS Function completed successfully.
TOOLKIT_FAILURE Function did not complete successfully. Check comm_status to see if the failure was the result of a communication failure.

Return Value

None.