lineSetDevConfig
The lineSetDevConfig
function allows the application to restore the configuration of a media stream
device on a line device to a setup previously obtained using lineGetDevConfig. For example, the contents
of this structure could specify data rate, character format, modulation
schemes, and error control protocol settings for a "datamodem" media
device associated with the line.
LONG lineSetDevConfig(
|
DWORD dwDeviceID, |
|
|
LPVOID
const lpDeviceConfig, |
|
|
DWORD dwSize, |
|
|
LPCSTR lpszDeviceClass |
|
|
); |
|
Parameters
dwDeviceID
The line
device to be configured.
lpDeviceConfig
A pointer to
the opaque configuration data structure that was returned by lineGetDevConfig
in the variable portion of the VARSTRING structure.
dwSize
The number of
bytes in the structure pointed to by lpDeviceConfig. This value will
have been returned in the dwStringSize field in the VARSTRING
structure returned by lineGetDevConfig.
lpszDeviceClass
A pointer to
a NULL-terminated ASCII string that specifies the device class of the device
whose configuration is to be set. Valid device class strings are the same as
those specified for the lineGetID function.
Return Values
Returns zero
if the function is successful or a negative error number if an error has
occurred. Possible return values are:
LINEERR_BADDEVICEID,
LINEERR_NODRIVER, LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONUNAVAIL,
LINEERR_INVALPOINTER, LINEERR_OPERATIONFAILED, LINEERR_INVALPARAM, LINEERR_RESOURCEUNAVAIL,
LINEERR_INVALLINESTATE, LINEERR_UNINITIALIZED, LINEERR_NOMEM, LINEERR_NODEVICE.
Remarks
Call states
are device specific.
Typically, an
application will call lineGetID to identify the media stream device
associated with a line, and then call lineConfigDialog to allow the user to set up
the device configuration. It could then call lineGetDevConfig and save
the configuration information in a phone book or other database associated with
a particular call destination. When the user wants to call the same destination
again, this function lineSetDevConfig can be used to restore the
configuration settings selected by the user. The lineSetDevConfig, lineConfigDialog,
and lineGetDevConfig functions can be used, in that order, to allow the
user to view and update the settings.
The exact
format of the data contained within the structure is specific to the line and
media stream API (device class), is undocumented, and is undefined. The
application must treat it as "opaque" and not manipulate the contents
directly. Generally, the structure can be sent using this function only to the
same device from which it was obtained. Certain Telephony service providers
may, however, permit structures to be interchanged between identical devices
(that is, multiple ports on the same multi-port modem card). Such
interchangeability is not guaranteed in any way, even for devices of the same
device class.
Note that
some service providers may permit the configuration to be set while a call is
active, and others may not.
See Also