INtime SDK Help
hpeOpenWithOptions
INtime SDK v7.1 > About INtime > Networking and I/O > High-Performance Ethernet > hpeOpenWithOptions

Initializes an Ethernet interface by loading the appropriate device driver. This function is similar to hpeOpen but additional options can be specified. Refer to the HPE_OPEN_OPTIONS structure for available options.

HPESTATUS hpeOpenWithOptions(
    const char *interface_name,
    const HPE_OPEN_OPTIONS *options,
    DWORD size_of_options,
    HPEHANDLE *p_devhandle
);

Parameters

interface_name
A string that contains the interface name and the device instance. See Remarks section for more details.
options
A pointer to HPE_OPEN_OPTIONS structure.
size_of_options
Size of the structure pointed-to by the options parameter.
p_devhandle
A pointer to a location where the handle is to be returned. This value is only valid if the call succeeds.

Remarks

The interface name identifies which driver mode is to be loaded, and the instance of the device which is to be used. For example, the interface name ie1g0 indicates that the ie1g.rsl driver is to be loaded and that the first instance of a device which is controlled by that driver is to be used. This naming convention matches that used by the TCP/IP software stack.

When this call is made the driver module is loaded and the interface initialized according to the call parameters. A check is made that the interface is not already in use either by another HPE application or by the TCP/IP software stack.

Not all device driver modules used by the TCP/IP software stack also have HPE support. The device driver modules which may be used by HPE include ie1g, rtl1g and rtl1gl.

Return Values

A status value indicating the success or failure of the operation:

E_OK The operation completed successfully.
E_EXIST The name given in the interface_name parameter does not correspond to an existing interface.
E_NOT_CONFIGURED The driver specified by interface_name does not support the HPE API.
E_STATE The interface specified by interface_name is already open.
E_PARAM One of the fields phy_params or interrupt_mode is not valid.
E_INVALID_ADDR The p_devhandle parameter is not a valid pointer address.
E_IO An error occurred during hardware initialization, including failing to detect link up status.
E_TIME The link status didn't change to up status within an internally defined timeout period.

Requirements

Versions Defined in Include Link to
INtime 4.0 intime/rt/include/hpeif2.h hpeif2.h hpeif2.lib
See Also