Port Entity

group PortEntity

Port Class: The Port Entity provides software control over the most basic items related to a USB Port. This includes everything from the complete enable and disable of the entire port to the individual control of specific pins. Voltage and Current measurements are also included for devices which support the Port Entity.

void port_getVbusVoltage(unsigned int *id, struct Result *result, const int index)

Gets the Vbus Voltage

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getVbusCurrent(unsigned int *id, struct Result *result, const int index)

Gets the Vbus Current

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getVconnVoltage(unsigned int *id, struct Result *result, const int index)

Gets the Vconn Voltage

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getVconnCurrent(unsigned int *id, struct Result *result, const int index)

Gets the Vconn Current

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getPowerMode(unsigned int *id, struct Result *result, const int index)

Gets the Port Power Mode: Convenience Function of get/setPortMode

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setPowerMode(unsigned int *id, struct Result *result, const int index, const unsigned char powerMode)

Sets the Port Power Mode: Convenience Function of get/setPortMode

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • powerMode – The power mode to be set.

Returns:

Returns common entity return values

void port_getEnabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the entire port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Fully enable port; 0 = Fully disable port.

Returns:

Returns common entity return values

void port_getDataEnabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the data lines.: Sub-component (Data) of getEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the data lines. Sub-component (Data) of setEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable data; 0 = Disable data.

Returns:

Returns common entity return values

void port_getDataHSEnabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the High Speed (HS) data lines. Sub-component of getDataEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataHSEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the High Speed (HS) data lines. Sub-component of setDataEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable data; 0 = Disable data.

Returns:

Returns common entity return values

void port_getDataHS1Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the High Speed A side (HSA) data lines.: Sub-component of getDataHSEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataHS1Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Hight Speed A side (HSA) data lines. Sub-component of setDataHSEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable data; 0 = Disable data.

Returns:

Returns common entity return values

void port_getDataHS2Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the High Speed B side (HSB) data lines.: Sub-component of getDataHSEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataHS2Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Hight Speed B side (HSB) data lines. Sub-component of setDataHSEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable data; 0 = Disable data.

Returns:

Returns common entity return values

void port_getDataSSEnabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the Super Speed (SS) data lines. Sub-component of getDataEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataSSEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Super Speed (SS) data lines. Sub-component of setDataEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable data; 0 = Disable data.

Returns:

Returns common entity return values

void port_getDataSS1Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the Super Speed A side (SSA) data lines.: Sub-component of getDataSSEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataSS1Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Super Speed (SS) data lines. Sub-component of setDataEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable data; 0 = Disable data.

Returns:

Returns common entity return values

void port_getDataSS2Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the Super Speed B side (SSB) data lines.: Sub-component of getDataSSEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataSS2Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Super Speed B side (SSB) data lines. Sub-component of setDataSSEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable data; 0 = Disable data.

Returns:

Returns common entity return values

void port_getPowerEnabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the power lines.: Sub-component (Power) of getEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setPowerEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or Disables the power lines. Sub-component (Power) of setEnable.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable power; 0 = Disable disable.

Returns:

Returns common entity return values

void port_getDataRole(unsigned int *id, struct Result *result, const int index)

Gets the Port Data Role.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getVconnEnabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the Vconn lines.: Sub-component (Vconn) of getEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setVconnEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Vconn lines. Sub-component (Vconn) of setEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable Vconn lines; 0 = Disable Vconn lines.

Returns:

Returns common entity return values

void port_getVconn1Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the Vconn1 lines. Sub-component of getVconnEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setVconn1Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Vconn1 lines. Sub-component of setVconnEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable Vconn1 lines; 0 = Disable Vconn1 lines.

Returns:

Returns common entity return values

void port_getVconn2Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the Vconn2 lines. Sub-component of getVconnEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setVconn2Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the Vconn2 lines. Sub-component of setVconnEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable Vconn2 lines; 0 = Disable Vconn2 lines.

Returns:

Returns common entity return values

void port_getCCEnabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the CC lines.: Sub-component (CC) of getEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setCCEnabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the CC lines. Sub-component (CC) of setEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable CC lines; 0 = Disable CC lines.

Returns:

Returns common entity return values

void port_getCC1Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the CC1 lines. Sub-component of getCCEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setCC1Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the CC1 lines. Sub-component of setCCEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable CC1 lines; 0 = Disable CC1 lines.

Returns:

Returns common entity return values

void port_getCC2Enabled(unsigned int *id, struct Result *result, const int index)

Gets the current enable value of the CC2 lines. Sub-component of getCCEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setCC2Enabled(unsigned int *id, struct Result *result, const int index, const unsigned char enable)

Enables or disables the CC2 lines. Sub-component of setCCEnabled.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • enable – 1 = Enable CC2 lines; 0 = Disable CC2 lines.

Returns:

Returns common entity return values

void port_getVoltageSetpoint(unsigned int *id, struct Result *result, const int index)

Gets the current voltage setpoint value for the port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setVoltageSetpoint(unsigned int *id, struct Result *result, const int index, const unsigned int value)

Sets the current voltage setpoint value for the port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • value – the voltage setpoint of the port in uV.

Returns:

Returns common entity return values

void port_getState(unsigned int *id, struct Result *result, const int index)

A bit mapped representation of the current state of the port. Reflects what he port IS which may differ from what was requested.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

void port_getDataSpeed(unsigned int *id, struct Result *result, const int index)

Gets the speed of the enumerated device.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getMode(unsigned int *id, struct Result *result, const int index)

Gets current mode of the port

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setMode(unsigned int *id, struct Result *result, const int index, const unsigned int mode)

Sets the mode of the port

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • mode – Port mode to be set. See product datasheet for details.

Returns:

Returns common entity return values

void port_getErrors(unsigned int *id, struct Result *result, const int index)

Returns any errors that are present on the port. Calling this function will clear the current errors. If the error persists it will be set again.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getCurrentLimit(unsigned int *id, struct Result *result, const int index)

Gets the current limit of the port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setCurrentLimit(unsigned int *id, struct Result *result, const int index, const unsigned int limit)

Sets the current limit of the port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • limit – Current limit to be applied in microAmps (uA).

Returns:

Returns common entity return values

void port_getCurrentLimitMode(unsigned int *id, struct Result *result, const int index)

Gets the current limit mode. The mode determines how the port will react to an over current condition.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setCurrentLimitMode(unsigned int *id, struct Result *result, const int index, const unsigned char mode)

Sets the current limit mode. The mode determines how the port will react to an over current condition.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • mode – An enumerated representation of the current limit mode. Available modes are product specific. See the reference documentation.

Returns:

Returns common entity return values

void port_getAvailablePower(unsigned int *id, struct Result *result, const int index)

Gets the current available power. This value is determined by the power manager which is responsible for budgeting the systems available power envelope.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getAllocatedPower(unsigned int *id, struct Result *result, const int index)

Gets the currently allocated power This value is determined by the power manager which is responsible for budgeting the systems available power envelope.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getPowerLimit(unsigned int *id, struct Result *result, const int index)

Gets the user defined power limit for the port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setPowerLimit(unsigned int *id, struct Result *result, const int index, const unsigned int limit)

Sets a user defined power limit for the port.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • limit – Power limit to be applied in milli-watts (mW).

Returns:

Returns common entity return values

void port_getPowerLimitMode(unsigned int *id, struct Result *result, const int index)

Gets the power limit mode. The mode determines how the port will react to an over power condition.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setPowerLimitMode(unsigned int *id, struct Result *result, const int index, const unsigned char mode)

Sets the power limit mode. The mode determines how the port will react to an over power condition.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • mode – An enumerated representation of the power limit mode to be applied Available modes are product specific. See the reference documentation.

Returns:

Returns common entity return values

void port_getName(unsigned int *id, struct Result *result, const int index, unsigned char *buffer, const int bufferLength)

Gets a user defined name of the port. Helpful for identifying ports/devices in a static environment.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • buffer – pointer to the start of a c style buffer to be filled

  • bufLength – Length of the buffer to be filed

  • unloadedLength – Length that was actually received and filled.

Returns:

Returns common entity return values

void port_setName(unsigned int *id, struct Result *result, const int index, unsigned char *buffer, const int bufferLength)

Sets a user defined name of the port. Helpful for identifying ports/devices in a static environment.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • buffer – Pointer to the start of a c style buffer to be transferred.

  • bufLength – Length of the buffer to be transferred.

Returns:

Returns common entity return values

void port_getDataHSRoutingBehavior(unsigned int *id, struct Result *result, const int index)

Gets the HighSpeed Data Routing Behavior. The mode determines how the port will route the data lines.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataHSRoutingBehavior(unsigned int *id, struct Result *result, const int index, const unsigned char mode)

Sets the HighSpeed Data Routing Behavior. The mode determines how the port will route the data lines.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • mode – An enumerated representation of the routing behavior. Available modes are product specific. See the reference documentation.

Returns:

Returns common entity return values

void port_getDataSSRoutingBehavior(unsigned int *id, struct Result *result, const int index)

Gets the SuperSpeed Data Routing Behavior. The mode determines how the port will route the data lines.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setDataSSRoutingBehavior(unsigned int *id, struct Result *result, const int index, const unsigned char mode)

Sets the SuperSpeed Data Routing Behavior. The mode determines how the port will route the data lines.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • mode – An enumerated representation of the routing behavior. Available modes are product specific. See the reference documentation.

Returns:

Returns common entity return values

void port_getVbusAccumulatedPower(unsigned int *id, struct Result *result, const int index)

Gets the Vbus Accumulated Power

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_resetVbusAccumulatedPower(unsigned int *id, struct Result *result, const int index)

Resets the Vbus Accumulated Power to zero.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_getVconnAccumulatedPower(unsigned int *id, struct Result *result, const int index)

Gets the Vconn Accumulated Power

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_resetVconnAccumulatedPower(unsigned int *id, struct Result *result, const int index)

Resets the Vconn Accumulated Power to zero.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_setHSBoost(unsigned int *id, struct Result *result, const int index, const unsigned char boost)

Sets the ports USB 2.0 High Speed Boost Settings The setting determines how much additional drive the USB 2.0 signal will have in High Speed mode.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • boost – An enumerated representation of the boost range. Available value are product specific. See the reference documentation.

Returns:

Returns common entity return values

void port_getHSBoost(unsigned int *id, struct Result *result, const int index)

Gets the ports USB 2.0 High Speed Boost Settings The setting determines how much additional drive the USB 2.0 signal will have in High Speed mode.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

void port_resetEntityToFactoryDefaults(unsigned int *id, struct Result *result, const int index)

Resets the PortClass Entity to it factory default configuration.

Parameters:
  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values