imgInterfaceQueryNames

NI IMAQ Function

imgInterfaceQueryNames

Usage

rval imgInterfaceQueryNames(uInt32 index, char* name);

Purpose

Returns the interface name identified by the index parameter. To obtain a list of all the available interface names, call this function repeatedly until the function returns an error. Make the first call with index initialized to zero. Each successive call increments the value of index by one.

Note  This function will not enumerate the individual port numbers for interfaces that support multiple ports. For example, an interface img0 that supports two ports will still be enumerated as img0. To query the number of ports that an interface supports, open port 0 of the interface and query the attribute IMG_ATTR_NUM_PORTS.

Parameters

Name Type Direction
index uInt32 input
name char* output
rval Int32 output

Parameter Discussion

index: interface number to obtain.

name: pointer to a character array to receive the interface name. The array must contain at least 256 elements.

Return Value

This function returns 0 on success. On failure, this function returns an error code. For information about the error code, call imgShowError.