LINECALLPARAMS

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure describes parameters supplied when making calls using the lineMakeCall function. The LINECALLPARAMS structure is also used as a parameter in other operations.

Syntax

typedef struct linecallparams_tag {
  DWORD dwTotalSize; 
  DWORD dwBearerMode;
  DWORD dwMinRate; 
  DWORD dwMaxRate; 
  DWORD dwMediaMode;
  DWORD dwCallParamFlags;
  DWORD dwAddressMode;
  DWORD dwAddressID;
  LINEDIALPARAMS DialParams;
  DWORD dwOrigAddressSize;
  DWORD dwOrigAddressOffset;
  DWORD dwDisplayableAddressSize; 
  DWORD dwDisplayableAddressOffset;
  DWORD dwCalledPartySize; 
  DWORD dwCalledPartyOffset;
  DWORD dwCommentSize; 
  DWORD dwCommentOffset;
  DWORD dwUserUserInfoSize; 
  DWORD dwUserUserInfoOffset;
  DWORD dwHighLevelCompSize; 
  DWORD dwHighLevelCompOffset;
  DWORD dwLowLevelCompSize; 
  DWORD dwLowLevelCompOffset;
  DWORD dwDevSpecificSize; 
  DWORD dwDevSpecificOffset;
  DWORD dwPredictiveAutoTransferStates;
  DWORD dwTargetAddressSize;
  DWORD dwTargetAddressOffset;
  DWORD dwSendingFlowspecSize;
  DWORD dwSendingFlowspecOffset;
  DWORD dwReceivingFlowspecSize;
  DWORD dwReceivingFlowspecOffset;
  DWORD dwDeviceClassSize;
  DWORD dwDeviceClassOffset;
  DWORD dwDeviceConfigSize;
  DWORD dwDeviceConfigOffset;
  DWORD dwCallDataSize;
  DWORD dwCallDataOffset;
  DWORD dwNoAnswerTimeout;
  DWORD dwCallingPartyIDSize;
  DWORD dwCallingPartyIDOffset;
  DWORD dwAddressType;
} LINECALLPARAMS, FAR* LPLINECALLPARAMS;

Members

  • dwTotalSize
    Total size, in bytes, allocated to this data structure. This size should be big enough to hold all the fixed and variably sized portions of this data structure.

  • dwBearerMode
    Value that specifies the bearer mode for the call. If dwBearerMode is set to any value except LINEBEARERMODE_PASSTHROUGH, the call will attempt to complete if or not that bearer mode is supported on the line being accessed. This member uses LINEBEARERMODE.

    If dwBearerMode is zero, the default value is LINEBEARERMODE_VOICE.

  • dwMinRateand dwMaxRate
    Value that specifies the data rate range requested for the call's data stream in bps (bits per second). When making a call, the service provider attempts to provide the highest available rate in the requested range. If a specific data rate is required, both min and max should be set to that value. If an application works best with one rate but is able to degrade to lower rates, the application should specify these as the maximum and minimum rates, respectively. If dwMaxRate is zero, the default value is as specified by the dwMaxRate member of the LINEDEVCAPS structure. This is the maximum rate supported by the device.
  • dwMediaMode
    Value that specifies the expected media mode of the call. This member uses LINEMEDIAMODE. If dwMediaMode is zero, the default value is LINEMEDIAMODE_INTERACTIVEVOICE.
  • dwCallParamFlags
    Value that specifies a collection of Boolean call-setup parameters. This member uses LINECALLPARAMFLAGS.
  • dwAddressMode
    Value that specifies the mode by which the originating address is specified. The dwAddressMode member cannot be LINEADDRESSMODE_ADDRESSID for the lineOpen function call. This member uses LINEADDRESSMODE.
  • dwAddressID
    Address identifier of the originating address if dwAddressMode is set to LINEADDRESSMODE_ADDRESSID.
  • DialParams
    Unsupported; set to zero.
  • dwOrigAddressSize
    Size, in bytes, of the field holding the originating address.
  • dwOrigAddressOffset
    Offset, in bytes, from the beginning of this data structure. The format of this address is dependent on the dwAddressMode member.
  • dwDisplayableAddressSize
    Specifies the displayable string that is used for logging purposes. The content of thi string is recorded in the dwDisplayableAddressOffset and dwDisplayableAddressSize members of the call's LINE_CALLINFO message. The lineTranslateAddress function returns appropriate data to be placed in this field in the dwDisplayableAddressSize member of the LINETRANSLATEOUTPUT structure.
  • dwDisplayableAddressOffset
    Specifies the displayable string that is used for logging purposes. The content of thi string is recorded in the dwDisplayableAddressOffset and dwDisplayableAddressSize members of the call's LINE_CALLINFO message. The lineTranslateAddress function returns appropriate data to be placed in this field in the dwDisplayableAddressOffset member of the LINETRANSLATEOUTPUT structure.
  • dwCalledPartySize
    Size, in bytes, of the field that holds called-party data.
  • dwCalledPartyOffset
    Offset, in bytes, from the beginning of this data structure. This data can be specified by the application that makes the call and is made available in the call's data structure for logging purposes. The format of this field is that of dwStringFormat, as specified in LINEDEVCAPS.
  • dwCommentSize
    Size, in bytes, of the field that holds comments about the call.
  • dwCommentOffset
    Offset, in bytes, from the beginning of this data structure. This data can be specified by the application that makes the call and is made available in the call's data structure for logging purposes. The format of this field is that of dwStringFormat, as specified in LINEDEVCAPS.
  • dwUserUserInfoSize
    Size, in bytes, of the field that holds user-user data.
  • dwUserUserInfoOffset
    Offset, in bytes, from the beginning of this data structure. The protocol discriminator field for the user-user data, if required, should appear as the first byte of the data pointed to by dwUserUserInfoOffset, and must be accounted for in dwUserUserInfoSize.
  • dwHighLevelCompSize
    Size, in bytes, of the field that holds high-level compatibility data.
  • dwHighLevelCompOffset
    Offset, in bytes, from the beginning of this data structure.
  • dwLowLevelCompSize
    Size, in bytes, of the field that holds low-level compatibility data.
  • dwLowLevelCompOffset
    Offset, in bytes, from the beginning of this data structure.
  • dwDevSpecificSize
    Size, in bytes, of the field that holds device-specific data.
  • dwDevSpecificOffset
    Offset, in bytes, from the beginning of this data structure.
  • dwPredictiveAutoTransferStates
    The LINECALLSTATE_ values, entry into which cause the call to be blind-transferred to the specified target address. Set to zero if automatic transfer is not desired.
  • dwTargetAddressSize
    Size, in bytes, of a string specifying the target address that can be dialed — not dwAddressID. Used in the case of certain automatic actions. In the case of predictive dialing, specifies the address to which the call should be automatically transferred. Set to zero if automatic transfer is not desired. In the case of a No Hold Conference, specifies the address that should be added to the call. In the case of a One Step Transfer, specifies the address to dial on the consultation call.
  • dwTargetAddressOffset
    Offset from the beginning of LINECALLPARAMS of a string specifying the target dialable address — not dwAddressID. Used in the case of certain automatic actions. In the case of predictive dialing, specifies the address to which the call should be automatically transferred. Set to zero if automatic transfer is not desired. In the case of a No Hold Conference, specifies the address that should be added to the call. In the case of a One Step Transfer, specifies the address to dial on the consultation call.
  • dwSendingFlowspecSize
    Total size, in bytes, of a Winsock2 FLOWSPEC structure followed by Winsock2 provider-specific data.
  • dwSendingFlowspecOffset
    Offset from the beginning of LINECALLPARAMS of a Winsock2 FLOWSPEC structure followed by Winsock2 provider-specific data. The provider-specific portion following the FLOWSPEC structure must not contain pointers to other blocks of memory, because TAPI does not know how to marshal the data pointed to by the private pointers and convey it through interprocess communication to the application.
  • dwReceivingFlowspecSize
    Total size, in bytes, of a Winsock2 FLOWSPEC structure.
  • dwReceivingFlowspecOffset
    Offset from the beginning of LINECALLPARAMS of a Winsock2 FLOWSPEC structure. The provider-specific portion following the FLOWSPEC structure must not contain pointers to other blocks of memory, because TAPI does not know how to marshal the data pointed to by the private pointers and convey it through interprocess communication to the application.
  • dwDeviceClassSize
    Size, in bytes, of a null-terminated ASCII string (the size includes the NULL) that indicates the device class of the device whose configuration is specified in DeviceConfig. Valid device class strings are the same as those specified for the lineGetID function.
  • dwDeviceClassOffset
    Offset from the beginning of LINECALLPARAMS of a null-terminated ASCII string (the size includes the NULL) that indicates the device class of the device whose configuration is specified in DeviceConfig.
  • dwDeviceConfigSize
    Size, in bytes, of the opaque configuration data structure pointed to by dwDevConfigOffset. This value is returned in the dwStringSize member in the VARSTRING structure returned by lineGetDevConfig. If the size is zero, the default device configuration is used. This enables the application to set the device configuration before the call is initiated.
  • dwDeviceConfigOffset
    Offset from the beginning of LINECALLPARAMS of the opaque configuration data structure pointed to by dwDevConfigOffset.
  • dwCallDataSize
    Size, in bytes, of the application-settable call data to be initially attached to the call.
  • dwCallDataOffset
    Offset from the beginning of LINECALLPARAMS of the application-settable call data to be initially attached to the call.
  • dwNoAnswerTimeout
    Number of seconds, after the completion of dialing, that the call should wait in the PROCEEDING or RINGBACK state, before abandoned by the service provider with a LINECALLSTATE_DISCONNECTED and LINEDISCONNECTMODE_NOANSWER. A value of zero indicates that the application does not desire automatic call abandonment.
  • dwCallingPartyIDSize
    Size, in bytes, of a null-terminated ASCII string (the size includes the NULL) that specifies the identity of the party placing the call.
  • dwCallingPartyIDOffset
    Offset from the beginning of LINECALLPARAMS of a null-terminated ASCII string (the size includes the NULL) that specifies the identity of the party placing the call. If the content of the identifier is acceptable and a path is available, the service provider passes the identifier along to the called party to indicate the identity of the calling party.
  • dwAddressType
    Address type used for the call. This member is available only if the negotiated TAPI version is 3.0 or later.

Remarks

Device-specific extensions should use the dwDevSpecificSize and dwDevSpecificOffset members of this structure.

This structure is used as a parameter to the lineMakeCall function when setting up a call. Its fields enable the application to specify a variety of ISDN call-setup parameters. If no LINECALLPARAMS structure is supplied to lineMakeCall, a default POTS voice-grade call is requested with the default values listed above.

Note

The members dwOrigAddressSize through dwDevSpecificOffset are ignored when an lpCallParams parameter is specified with the lineOpen function.

For Windows CE 1.0 through 2.12, the following members are not supported:

  • dwUUISendUserUserInfoSize
  • dwDeviceClassSize
  • dwMinRate
  • dwDeviceClassOffset
  • dwMaxRate
  • dwDeviceConfigSize
  • dwPredictiveAutoTransferStates
  • dwDeviceConfigOffset
  • dwTargetAddressSize
  • dwCallDataSize
  • dwTargetAddressOffset
  • dwCallDataOffset
  • dwSendingFlowspecSize
  • dwNoAnswerTimeout
  • dwSendingFlowspecOffset
  • dwCallingPartyIDSize
  • dwReceivingFlowspecSize
  • dwCallingPartyIDOffset
  • dwReceivingFlowspecOffset

Requirements

Header tapi.h
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

lineMakeCall
lineOpen
lineGetID
lineGetDevConfig
lineTranslateAddress
LINEDEVCAPS
LINETRANSLATEOUTPUT
VARSTRING