UNIMDM_CHG_DEVCFG (Compact 2013)

3/26/2014

This structure provides an interface to programmatically edit or retrieve the Unimodem device configuration.

Syntax

typedef struct _UNIMDM_CHG_DEVCFG {
  DWORD dwCommand; 
  LPCWSTR lpszDeviceClass; 
  LPVARSTRING lpDeviceConfig; 
  DWORD dwOption; 
  DWORD dwValue; 
} UNIMDM_CHG_DEVCFG; 

Members

• dwCommand
  Value that controls whether the device configuration is retrieved or edited. The following table shows possible values for dwCommand.

  Value	Description
  UNIMDM_CMD_CHG_DEVCFG	Command to edit the device configuration.
  UNIMDM_CMD_GET_DEVCFG	Command to retrieve the device configuration.

• lpszDeviceClass
  Pointer to a null-terminated string that identifies a device class name.

• lpDeviceConfig
  Pointer to the device configuration to be retrieved or edited.

• dwOption
  Value that selects the option to be retrieved or changed in the device configuration. The following table shows possible values for dwOption.

  Value	Description
  UNIMDM_OPT_BAUDRATE	The baud rate at which the Unimodem operates. Valid values are the CBR_* values that are defined in Winbase.h.
  UNIMDM_OPT_BYTESIZE	The size of the UNIMDM_CHG_DEVCFG structure in bytes.
  UNIMDM_OPT_PARITY	The valid values are defined in Winbase.h.
  UNIMDM_OPT_STOPBITS	The valid values are defined in Winbase.h.
  UNIMDM_OPT_WAITBONG	The number of seconds to wait for a prompt tone.
  UNIMDM_OPT_MDMOPTIONS	Selects the Unimodem option to be retrieved or changed. Valid values are the MDM_* values defined in Mcx.h. Currently, the supported options are MDM_BLIND_DIAL, MDM_FLOWCONTROL_HARD, MDM_FLOWCONTROL_SOFT, and MDM_SPEED_ADJUST. MDM_SPEED_ADJUST enables automatic baud rate detection on a DCC client connection.
  UNIMDM_OPT_TIMEOUT	The number of seconds before a call time-out failure.
  UNIMDM_OPT_TERMOPTIONS	The terminal dialing options. Valid values are defined in Netui.h.
  UNIMDM_OPT_DIALMOD	The dial modifier. The dwValue parameter must be type LPCWSTR.

• dwValue
  If dwCommandis UNIMDM_CMD_CHG_DEVCFG, this member should contain the new option value. If dwCommandis UNIMDM_CMD_GET_DEVCFG, this member will receive the current option value.

Remarks

Changes are applied to the DevConfig structure only and do not affect the current state of the associated line device.

The following code example demonstrates how to use this structure.

PUNIMDM_CHG_DEVCFG pUniMdmChgDevCfg;
// allocate and set up pUniMdmChgDevCfg fields 
pUniMdmChgDevCfg->dwCommand = UNIMDM_CMD_CHG_DEVCFG;
rc = lineDevSpecific(
          hLine,
          0,
          NULL,
          pUniMdmChgDevCfg,
          sizeof(UNIMDM_CHG_DEVCFG));

Requirements

Header

unimodem.h

See Also

Reference

TAPI Structures
UNIMODEM_INFO