LINEADDRESSCAPS
The LINEADDRESSCAPS
structure describes the capabilities of a specified address.
typedef struct lineaddresscaps_tag {
DWORD
dwTotalSize;
DWORD dwNeededSize;
DWORD dwUsedSize;
DWORD dwLineDeviceID;
DWORD dwAddressSize;
DWORD dwAddressOffset;
DWORD dwDevSpecificSize;
DWORD dwDevSpecificOffset;
DWORD dwAddressSharing;
DWORD dwAddressStates;
DWORD dwCallInfoStates;
DWORD dwCallerIDFlags;
DWORD dwCalledIDFlags;
DWORD dwConnectedIDFlags;
DWORD dwRedirectionIDFlags;
DWORD dwRedirectingIDFlags;
DWORD dwCallStates;
DWORD dwDialToneModes;
DWORD dwBusyModes;
DWORD dwSpecialInfo;
DWORD dwDisconnectModes;
DWORD dwMaxNumActiveCalls;
DWORD dwMaxNumOnHoldCalls;
DWORD dwMaxNumOnHoldPendingCalls;
DWORD
dwMaxNumConference;
DWORD dwMaxNumTransConf;
DWORD dwAddrCapFlags;
DWORD dwCallFeatures;
DWORD dwRemoveFromConfCaps;
DWORD dwRemoveFromConfState;
DWORD dwTransferModes;
DWORD dwParkModes;
DWORD dwForwardModes;
DWORD dwMaxForwardEntries;
DWORD dwMaxSpecificEntries;
DWORD dwMinFwdNumRings;
DWORD dwMaxFwdNumRings;
DWORD dwMaxCallCompletions;
DWORD dwCallCompletionConds;
DWORD dwCallCompletionModes;
DWORD dwNumCompletionMessages;
DWORD dwCompletionMsgTextEntrySize;
DWORD dwCompletionMsgTextSize;
DWORD dwCompletionMsgTextOffset;
DWORD dwAddressFeatures;
DWORD dwPredictiveAutoTransferStates;
DWORD dwNumCallTreatments;
DWORD
dwCallTreatmentListSize;
DWORD dwCallTreatmentListOffset;
DWORD dwDeviceClassesSize;
DWORD dwDeviceClassesOffset;
DWORD dwMaxCallDataSize;
DWORD dwCallFeatures2;
DWORD dwMaxNoAnswerTimeout;
DWORD dwConnectedModes;
DWORD dwOfferingModes;
DWORD dwAvailableMediaModes;
} LINEADDRESSCAPS, FAR *LPLINEADDRESSCAPS;
Members
dwTotalSize
The total
size in bytes allocated to this data structure.
dwNeededSize
The size in
bytes for this data structure that is needed to hold all the returned
information.
dwUsedSize
The size in
bytes of the portion of this data structure that contains useful information.
dwLineDeviceID
The device ID
of the line device with which this address is associated.
dwAddressSize
dwAddressOffset
The size in
bytes of the variably sized address field and the offset in bytes from the
beginning of this data structure.
dwDevSpecificSize
dwDevSpecificOffset
The size in
bytes of the variably sized device-specific field and the offset in bytes from
the beginning of this data structure.
dwAddressSharing
The sharing
mode of the address. Values are:
LINEADDRESSSHARING_PRIVATE
An address
with private sharing mode is only assigned to a single line or station.
LINEADDRESSSHARING_BRIDGEDEXCL
An address
with a bridged-exclusive sharing mode is assigned to one or more other
lines or stations. The exclusive portion refers to the fact that only
one of the bridged parties can be connected with a remote party at any given
time.
LINEADDRESSSHARING_BRIDGEDNEW
An address
with a bridged-new sharing mode is assigned to one or more other lines
or stations. The new portion refers to the fact that activities by the
different bridged parties result in the creation of new calls on the address.
LINEADDRESSSHARING_BRIDGEDSHARED
An address
with a bridged-shared sharing mode is also assigned to one or more other
lines or stations. The shared portion refers to the fact that if one of
the bridged parties is connected with a remote party, the remaining bridged
parties can share in the conversation (as in a conference) by activating that
call appearance.
LINEADDRESSSHARING_MONITORED
An address
with a monitored address mode simply monitors the status of that address. The
status is either idle or in use. The message LINE_ADDRESSSTATE notifies the application about
these changes.
dwAddressStates
This field
contains the address states changes for which the application may get notified
in the LINE_ADDRESSSTATE message. It uses the following LINEADDRESSSTATE_
constants:
LINEADDRESSSTATE_OTHER
Address
status items other than those listed below have changed. The application should
check the current address status to determine which items have changed.
LINEADDRESSSTATE_DEVSPECIFIC
The
device-specific item of the address status has changed.
LINEADDRESSSTATE_INUSEZERO
The address
has changed to idle (it is not in use by any stations).
LINEADDRESSSTATE_INUSEONE
The address
has changed from being idle or from being in use by many bridged stations to
being in use by just one station.
LINEADDRESSSTATE_INUSEMANY
The monitored
or bridged address has changed to being in use by one station to being used by
more than one station.
LINEADDRESSSTATE_NUMCALLS
The number of
calls on the address has changed. This is the result of events such as a new
inbound call, an outbound call on the address, or a call changing its hold
status.
LINEADDRESSSTATE_FORWARD
The
forwarding status of the address has changed, including the number of rings for
determining a "no answer" condition. The application should check the
address status to retrieve details about the address's current forwarding
status.
LINEADDRESSSTATE_TERMINALS
The terminal
settings for the address have changed.
LINEADDRESSSTATE_CAPSCHANGE
Indicates
that, due to configuration changes made by the user or other circumstances, one
or more of the fields in the LINEADDRESSCAPS structure for the address
have changed. The application should use lineGetAddressCaps to read the updated
structure. If a service provider sends a LINE_ADDRESSSTATE message containing this value
to TAPI, TAPI will pass it along to applications that have negotiated TAPI
version 0x00010004 or above; applications negotiating a previous API version
will receive LINE_LINEDEVSTATE
messages specifying LINEDEVSTATE_REINIT, requiring them to shutdown and
reinitialize their connection to TAPI in order to obtain the updated
information.
dwCallInfoStates
This field
describes the call information elements that are meaningful for all calls on
this address. An application may get notified about changes in some of these
states in LINE_CALLINFO
messages. It uses the following LINECALLINFOSTATE_ constants:
LINECALLINFOSTATE_OTHER
Call
information items other than those listed below have changed. The application
should check the current call information to determine which items have changed.
LINECALLINFOSTATE_DEVSPECIFIC
The
device-specific field of the call information.
LINECALLINFOSTATE_BEARERMODE
The bearer
mode field of the call information record.
LINECALLINFOSTATE_RATE
The rate
field of the call information record.
LINECALLINFOSTATE_MEDIAMODE
The
media-mode field of the call information record.
LINECALLINFOSTATE_APPSPECIFIC
The
application-specific field of the call information record.
LINECALLINFOSTATE_CALLID
The call ID
field of the call information record.
LINECALLINFOSTATE_RELATEDCALLID
The related
call ID field of the call information record.
LINECALLINFOSTATE_ORIGIN
The origin
field of the call information record.
LINECALLINFOSTATE_REASON
The reason
field of the call information record.
LINECALLINFOSTATE_COMPLETIONID
The completion
ID field of the call information record.
LINECALLINFOSTATE_NUMOWNERINCR
The number of
owner field in the call information record was increased.
LINECALLINFOSTATE_NUMOWNERDECR
The number of
owner field in the call information record was decreased.
LINECALLINFOSTATE_NUMMONITORS
The number of
monitors field in the call information record has changed.
LINECALLINFOSTATE_TRUNK
The trunk
field of the call information record has changed.
LINECALLINFOSTATE_CALLERID
One of the
callerID-related fields of the call information record has changed.
LINECALLINFOSTATE_CALLEDID
One of the
calledID-related fields of the call information record has changed.
LINECALLINFOSTATE_CONNECTEDID
One of the
connectedID-related fields of the call information record has changed.
LINECALLINFOSTATE_REDIRECTIONID
One of the
redirectionID-related fields of the call information record has changed.
LINECALLINFOSTATE_REDIRECTINGID
One of the
redirectingID-related fields of the call information record has changed.
LINECALLINFOSTATE_DISPLAY
The display
field of the call information record.
LINECALLINFOSTATE_USERUSERINFO
The
user-to-user information of the call information record.
LINECALLINFOSTATE_HIGHLEVELCOMP
The
high-level compatibility field of the call information record.
LINECALLINFOSTATE_LOWLEVELCOMP
The low-level
compatibility field of the call information record.
LINECALLINFOSTATE_CHARGINGINFO
The charging
information of the call information record.
LINECALLINFOSTATE_TERMINAL
The terminal
mode information of the call information record.
LINECALLINFOSTATE_DIALPARAMS
The dial
parameters of the call information record.
LINECALLINFOSTATE_MONITORMODES
One or more
of the digit, tone, or media monitoring fields in the call information record
has changed.
dwCallerIDFlags
dwCalledIDFlags
dwConnectedIDFlags
dwRedirectionIDFlags
dwRedirectingIDFlags
These fields
describe the various party ID information types that may be provided for calls
on this address. It uses the following LINECALLPARTYID_ constants:
LINECALLPARTYID_BLOCKED
Caller ID
information for the call has been blocked by the caller but would otherwise
have been available.
LINECALLPARTYID_OUTOFAREA
Caller ID
information for the call is not available because it is not propagated all the
way by the network.
LINECALLPARTYID_NAME
The caller ID
information for the call is the caller's name (from a table maintained inside
the switch). It is provided in the caller ID name variably sized field.
LINECALLPARTYID_ADDRESS
The caller ID
information for the call is the caller's number and is provided in the caller
ID variably sized field.
LINECALLPARTYID_PARTIAL
Caller ID
information for the call is valid but is limited to partial number information.
LINECALLPARTYID_UNKNOWN
Caller ID information
is currently unknown; it may become known later.
LINECALLPARTYID_UNAVAIL
Caller ID
information is unavailable and will not become known later.
dwCallStates
This field
describes the various call states that can possibly be reported for calls on
this address. This parameter uses the following LINECALLSTATE_ constants:
LINECALLSTATE_IDLE
The call is
idle no call exists.
LINECALLSTATE_OFFERING
The call is
being offered to the station, signaling the arrival of a new call. In some
environments, a call in the offering state does not automatically alert the
user; alerting is done by the switch instructing the line to ring. It does not
affect any call states.
LINECALLSTATE_ACCEPTED
The call was
offering and has been accepted. This indicates to other (monitoring)
applications that the current owner application has claimed responsibility for
answering the call. In ISDN, this also initiates alerting to both parties.
LINECALLSTATE_DIALTONE
The call is
receiving a dial tone from the switch, which means that the switch is ready to
receive a dialed number.
LINECALLSTATE_DIALING
Destination
address information (a phone number) is being sent to the switch over the call.
Note that the operation lineGenerateDigits does not place the line into the dialing
state.
LINECALLSTATE_RINGBACK
The call is
receiving ringback from the called address. Ringback indicates that the other
station has been reached and is being alerted.
LINECALLSTATE_BUSY
The call is
receiving a busy tone. Busy tone indicates that the call cannot be completed either a circuit (trunk) or the remote party's station
are in use.
LINECALLSTATE_SPECIALINFO
Special
information is sent by the network. Special information is typically sent when
the destination cannot be reached.
LINECALLSTATE_CONNECTED
The call has
been established and the connection is made. Information is able to flow over
the call between the originating address and the destination address.
LINECALLSTATE_PROCEEDING
Dialing has
completed and the call is proceeding through the switch or telephone network.
LINECALLSTATE_ONHOLD
The call is
on hold by the switch.
LINECALLSTATE_CONFERENCED
The call is
currently a member of a multiparty conference call.
LINECALLSTATE_ONHOLDPENDCONF
The call is
currently on hold while it is being added to a conference.
LINECALLSTATE_ONHOLDPENDTRANSF
The call is
currently on hold awaiting transfer to another number.
LINECALLSTATE_DISCONNECTED
The remote
party has disconnected from the call.
LINECALLSTATE_UNKNOWN
The state of
the call is not known. This may be due to limitations of the call progress
detection implementation.
dwDialToneModes
This field
describes the various dial tone modes that can possibly be reported for calls
made on this address. This field is meaningful only if the dialtone call
state can be reported. It uses the following LINEDIALTONEMODE_ constants:
LINEDIALTONEMODE_NORMAL
This is a
"normal" dial tone, which typically is a continuous tone.
LINEDIALTONEMODE_SPECIAL
This is a
special dial tone indicating a certain condition is currently in effect.
LINEDIALTONEMODE_INTERNAL
This is an
internal dial tone, as within a PBX.
LINEDIALTONEMODE_EXTERNAL
This is an
external (public network) dial tone.
LINEDIALTONEMODE_UNKNOWN
The dial tone
mode is currently unknown but may become known later.
LINEDIALTONEMODE_UNAVAIL
The dial tone
mode is unavailable and will not become known.
wBusyModes
This field
describes the various busy modes that can possibly be reported for calls made
on this address. This field is meaningful only if the busy call state
can be reported. It uses the following LINEBUSYMODE_ constants:
LINEBUSYMODE_STATION
The busy
signal indicates that the called party's station is busy. This is usually
signaled with a "normal" busy tone.
LINEBUSYMODE_TRUNK
The busy
signal indicates that a trunk or circuit is busy. This is usually signaled with
a "long" busy tone.
LINEBUSYMODE_UNKNOWN
The busy
signal's specific mode is currently unknown but may become known later.
LINEBUSYMODE_UNAVAIL
The busy
signal's specific mode is unavailable and will not become known.
dwSpecialInfo
This field
describes the various special information types that can possibly be reported
for calls made on this address. This field is meaningful only if the specialInfo
call state can be reported. It uses the following LINESPECIALINFO_ constants:
LINESPECIALINFO_NOCIRCUIT
This special
information tone precedes a no-circuit or emergency announcement (trunk
blockage category).
LINESPECIALINFO_CUSTIRREG
This special
information tone precedes a vacant number, AIS, Centrex number change and
nonworking station, access code not dialed or dialed in error, manual intercept
operator message (customer irregularity category).
LINESPECIALINFO_REORDER
This special
information tone precedes a reorder announcement (equipment irregularity
category).
LINESPECIALINFO_UNKNOWN
Specifics
about the special information tone are currently unknown but may become known
later.
LINESPECIALINFO_UNAVAIL
Specifics
about the special information tone are unavailable and will not become known.
dwDisconnectModes
This field
describes the various disconnect modes that can possibly be reported for calls
made on this address. This field is meaningful only if the disconnected
call state can be reported. It uses the following LINEDISCONNECTMODE_
constants:
LINEDISCONNECTMODE_NORMAL
This is a
"normal" disconnect request by the remote party; the call was
terminated normally.
LINEDISCONNECTMODE_UNKNOWN
The reason
for the disconnect request is unknown.
LINEDISCONNECTMODE_REJECT
The remote
user has rejected the call.
LINEDISCONNECTMODE_PICKUP
The call was
picked up from elsewhere.
LINEDISCONNECTMODE_FORWARDED
The call was
forwarded by the switch.
LINEDISCONNECTMODE_BUSY
The remote
user's station is busy.
LINEDISCONNECTMODE_NOANSWER
The remote
user's station does not answer.
LINEDISCONNECTMODE_NODIALTONE
A dial tone
was not detected within a service-provider defined timeout, at a point during
dialing when one was expected (such as at a "W" in the dialable string).
This can also occur without a service-provider-defined timeout period or without
a value specified in the dwWaitForDialTone member of the LINEDIALPARAMS structure.
LINEDISCONNECTMODE_BADADDRESS
The
destination address in invalid.
LINEDISCONNECTMODE_UNREACHABLE
The remote
user could not be reached.
LINEDISCONNECTMODE_CONGESTION
The network
is congested.
LINEDISCONNECTMODE_INCOMPATIBLE
The remote
user's station equipment is incompatible with the type of call requested.
LINEDISCONNECTMODE_UNAVAIL
The reason
for the disconnect is unavailable and will not become known later.
dwMaxNumActiveCalls
This field
contains the maximum number of active call appearances that the address can
handle. This number does not include calls on hold or calls on hold pending
transfer or conference.
dwMaxNumOnHoldCalls
This field
contains the maximum number of call appearances at the address that can be on
hold.
dwMaxNumOnHoldPendingCalls
This field
contains the maximum number of call appearances at the address that can be on
hold pending transfer or conference.
dwMaxNumConference
This field
contains the maximum number of parties that can be conferenced in a single
conference call on this address.
dwMaxNumTransConf
This field
specifies the number of parties (including "self") that can be added
in a conference call that is initiated as a generic consultation call using lineSetupTransfer.
dwAddrCapFlags
This field
contains a series of packed bit flags that describe a variety of address
capabilities. It uses the following LINEADDRCAPFLAGS_ constants:
LINEADDRCAPFLAGS_FWDNUMRINGS
Specifies
whether the number of rings for a "no answer" can be specified when
forwarding calls on no answer.
LINEADDRCAPFLAGS_PICKUPGROUPID
Specifies
whether or not a group ID is required for call pickup.
LINEADDRCAPFLAGS_SECURE
Specifies
whether or not calls on this address can be made secure at call-setup time.
LINEADDRCAPFLAGS_BLOCKIDDEFAULT
Specifies
whether the network by default sends or blocks caller ID information when
making a call on this address. If TRUE, ID information is blocked by default;
if FALSE, ID information is transmitted by default.
LINEADDRCAPFLAGS_BLOCKIDOVERRIDE
Specifies
whether the default setting for sending or blocking of caller ID information
can be overridden per call. If TRUE, override is possible; if FALSE, override
is not possible.
LINEADDRCAPFLAGS_DIALED
Specifies
whether a destination address can be dialed on this address for making a call.
TRUE if a destination address must be dialed; FALSE if the destination address
is fixed (as with a "hot phone").
LINEADDRCAPFLAGS_ORIGOFFHOOK
Specifies
whether the originating party's phone can automatically be taken offhook when
making calls.
LINEADDRCAPFLAGS_DESTOFFHOOK
Specifies
whether the called party's phone can automatically be forced offhook when
making calls.
LINEADDRCAPFLAGS_FWDCONSULT
Specifies
whether call forwarding involves the establishment of a consultation call.
LINEADDRCAPFLAGS_SETUPCONFNULL
Specifies
whether setting up a conference call starts out with an initial call (FALSE) or
with no initial call (TRUE).
LINEADDRCAPFLAGS_AUTORECONNECT
Specifies
whether dropping a consultation call automatically reconnects to the call on
consultation hold. TRUE if reconnect happens automatically; otherwise, FALSE.
LINEADDRCAPFLAGS_COMPLETIONID
Specifies
whether the completion IDs returned by lineCompleteCall are useful and unique. TRUE
is useful; otherwise, FALSE.
LINEADDRCAPFLAGS_TRANSFERHELD
Specifies
whether a (hard) held call can be transferred. Often, only calls on
consultation hold may be able to be transferred.
LINEADDRCAPFLAGS_CONFERENCEHELD
Specifies
whether a (hard) held call can be conferenced to. Often, only calls on
consultation hold may be able to be added to as a conference call.
LINEADDRCAPFLAGS_
PARTIALDIAL
Specifies
whether partial dialing is available.
LINEADDRCAPFLAGS_FWDSTATUSVALID
Specifies
whether the forwarding status in the LINEADDRESSSTATUS structure for this address
is valid.
LINEADDRCAPFLAGS_
FWDINTEXTADDR
Specifies
whether internal and external calls can be forwarded to different forwarding
addresses. This flag is meaningful only if forwarding of internal and external
calls can be controlled separately. It is TRUE if internal and external calls
can be forwarded to different destination addresses; otherwise, FALSE.
LINEADDRCAPFLAGS_
FWDBUSYNAADDR
Specifies
whether call forwarding for busy and for no answer can use different forwarding
addresses. This flag is meaningful only if forwarding for busy and for no
answer can be controlled separately. It is TRUE if forwarding for busy and for
no answer can use different destination addresses; otherwise, FALSE.
LINEADDRCAPFLAGS_ACCEPTTOALERT
TRUE if an
offering call must be accepted using lineAccept to start alerting the
users at both ends of the call; otherwise, FALSE. Typically, this is only used
with ISDN.
LINEADDRCAPFLAGS_CONFDROP
TRUE if
invoking lineDrop on a conference call parent also has the side effect
of dropping (disconnecting) the other parties involved in the conference call;
FALSE if dropping a conference call still allows the other parties to talk
among themselves.
LINEADDRCAPFLAGS_
PICKUPCALLWAIT
TRUE if linePickup
can be used to pick up a call detected by the user as a "call waiting"
call; otherwise FALSE.
dwCallFeatures
This field
specifies the switching capabilities or features available for all calls on
this address using the LINECALLFEATURE_ constants. This member represents the
call-related features which may possibly be available on an address (static
availability as opposed to dynamic availability). Invoking a supported feature
requires the call to be in the proper state and the underlying line device to
be opened in a compatible mode. A zero in a bit position indicates that the
corresponding feature is never available. A one indicates that the
corresponding feature may be available if the application has the right
privileges to the call and the call is in the appropriate state for the
operation to be meaningful. This field allows an application to discover which
call features can be (and which can never be) supported by the address.
dwRemoveFromConfCaps
This field
specifies the address's capabilities for removing calls from a conference call.
It uses the following LINEREMOVEFROMCONF_ constants:
LINEREMOVEFROMCONF_NONE
Parties
cannot be removed from the conference call.
LINEREMOVEFROMCONF_LAST
Only the most
recently added party can be removed from the conference call.
LINEREMOVEFROMCONF_ANY
Any
participating party can be removed from the conference call.
dwRemoveFromConfState
This field
uses the LINECALLSTATE_ constants to specify the state of the call after it has
been removed from a conference call.
dwTransferModes
This field
specifies the address's capabilities for resolving transfer requests. It uses
the following LINETRANSFERMODE_ constants:
LINETRANSFERMODE_TRANSFER
Resolve the
initiated transfer by transferring the initial call to the consultation call.
LINETRANSFERMODE_CONFERENCE
Resolve the
initiated transfer by conferencing all three parties into a three-way conference
call. A conference call is created and returned to the application.
dwParkModes
This field
specifies the different call park modes available at this address. It uses the
LINEPARKMODE_ constants:
LINEPARKMODE_DIRECTED
Specifies
directed call park. The address where the call is to be parked must be supplied
to the switch.
LINEPARKMODE_NONDIRECTED
Specifies
nondirected call park. The address where the call is parked is selected by the
switch and provided by the switch to the application.
dwForwardModes
This field
specifies the different modes of forwarding available for this address. It uses
the following LINEFORWARDMODE_ constants:
LINEFORWARDMODE_UNCOND
Forward all
calls unconditionally, irrespective of their origin. Use this value when
unconditional forwarding for internal and external calls cannot be controlled
separately. Unconditional forwarding overrides forwarding on busy and/or no
answer conditions.
LINEFORWARDMODE_UNCONDINTERNAL
Forward all
internal calls unconditionally. Use this value when unconditional forwarding
for internal and external calls can be controlled separately.
LINEFORWARDMODE_UNCONDEXTERNAL
Forward all
external calls unconditionally. Use this value when unconditional forwarding
for internal and external calls can be controlled separately.
LINEFORWARDMODE_UNCONDSPECIFIC
Forward all
calls that originated at a specified address unconditionally (selective call
forwarding).
LINEFORWARDMODE_BUSY
Forward all
calls on busy, irrespective of their origin. Use this value when forwarding for
internal and external calls on busy and on no answer cannot be controlled
separately.
LINEFORWARDMODE_BUSYINTERNAL
Forward all
internal calls on busy. Use this value when forwarding for internal and
external calls on busy and on no answer can be controlled separately.
LINEFORWARDMODE_BUSYEXTERNAL
Forward all
external calls on busy. Use this value when forwarding for internal and
external calls on busy and on no answer can be controlled separately.
LINEFORWARDMODE_BUSYSPECIFIC
Forward all
calls that originated at a specified address on busy (selective call
forwarding).
LINEFORWARDMODE_NOANSW
Forward all
calls on no answer, irrespective of their origin. Use this value when call
forwarding for internal and external calls on no answer cannot be controlled
separately.
LINEFORWARDMODE_NOANSWINTERNAL
Forward all
internal calls on no answer. Use this value when forwarding for internal and
external calls on no answer can be controlled separately.
LINEFORWARDMODE_NOANSWEXTERNAL
Forward all
external calls on no answer. Use this value when forwarding for internal and
external calls on no answer can be controlled separately.
LINEFORWARDMODE_NOANSWSPECIFIC
Forward all
calls that originated at a specified address on no answer (selective call
forwarding).
LINEFORWARDMODE_BUSYNA
Forward all
calls on busy/no answer, irrespective of their origin. Use this value when
forwarding for internal and external calls on busy and on no answer cannot be
controlled separately.
LINEFORWARDMODE_BUSYNAINTERNAL
Forward all
internal calls on busy/no answer. Use this value when call forwarding on busy
and on no answer cannot be controlled separately for internal calls.
LINEFORWARDMODE_BUSYNAEXTERNAL
Forward all
external calls on busy/no answer. Use this value when call forwarding on busy
and on no answer cannot be controlled separately for internal calls.
LINEFORWARDMODE_BUSYNASPECIFIC
Forward all
calls that originated at a specified address on busy/no answer (selective call
forwarding).
dwMaxForwardEntries
Specifies the
maximum number of entries that can be passed to lineForward in the lpForwardList
parameter.
dwMaxSpecificEntries
Specifies the
maximum number of entries in the lpForwardList parameter passed to lineForward
that can contain forwarding instructions based on a specific caller ID
(selective call forwarding). This field is zero if selective call forwarding is
not supported.
dwMinFwdNumRings
Specifies the
minimum number of rings that can be set to determine when a call is officially
considered "no answer."
dwMaxFwdNumRings
Specifies the
maximum number of rings that can be set to determine when a call is officially
considered "no answer." If this number of rings cannot be set, then dwMinFwdNumRings
and dwMaxNumRings will be equal.
dwMaxCallCompletions
Specifies the
maximum number of concurrent call completion requests that can be outstanding
on this line device. Zero implies that call completion is not available.
dwCallCompletionCond
Specifies the
different call conditions under which call completion can be requested. This
field uses the following LINECALLCOMPLCOND_ constants:
LINECALLCOMPLCOND_BUSY
Complete the
call under the busy condition.
LINECALLCOMPLCOND_NOANSWER
Complete the
call under the ringback no answer condition.
dwCallCompletionModes
Specifies the
way in which the call can be completed. This field uses the following
LINECALLCOMPLCOND_ constants:
LINECALLCOMPLMODE_CAMPON
Queues the
call until the call can be completed.
LINECALLCOMPLMODE_CALLBACK
Requests the
called station to return the call when it returns to idle.
LINECALLCOMPLMODE_INTRUDE
Adds the
application to the existing call at the called station if busy (barge in).
LINECALLCOMPLMODE_MESSAGE
Leave a short
predefined message for the called station (Leave Word Calling). A specific
message can be identified.
dwNumCompletionMessages
Specifies the
number of call completion messages that can be selected from when using the
LINECALLCOMPLMODE_MESSAGE option. Individual messages are identified by values
in the range 0 through one less than dwNumCompletionMessages.
dwCompletionMsgTextEntrySize
Specifies the
size in bytes of each of the call completion text descriptions pointed at by dwCompletionMsgTextSize/Offset.
dwCompletionMsgTextSize
dwCompletionMsgTextOffset
The size in
bytes and the offset in bytes from the beginning of this data structure of the
variably sized field containing descriptive text about each of the call
completion messages. Each message is dwCompletionMsgTextEntrySize bytes
long. The string format of these textual descriptions is indicated by dwStringFormat
in the line's device capabilities.
dwAddressFeatures
This field
specifies the features available for this address using the LINEADDRFEATURE_
constants. Invoking a supported feature requires the address to be in the
proper state and the underlying line device to be opened in a compatible mode.
A zero in a bit position indicates that the corresponding feature is never
available. A one indicates that the corresponding feature may be available if
the address is in the appropriate state for the operation to be meaningful.
This field allows an application to discover which address features can be (and
which can never be) supported by the address.
dwPredictiveAutoTransferStates
The call
state or states upon which a call made by a predictive dialer can be set to
automatically transfer the call to another address; one or more of the
LINECALLSTATE_ constants. The value 0 indicates automatic transfer based on
call state is unavailable.
dwNumCallTreatments
The number of
entries in the array of LINECALLTREATMENTENTRY1JUJ625 structures delimited by dwCallTreatmentSize
and dwCallTreatmentOffset.
dwCallTreatmentListSize
dwCallTreatmentListOffset
The total
size in bytes and offset from the beginning of LINEADDRESSCAPS of an
array of LINECALLTREATMENTENTRY structures, indicating the call
treatments supported on the address (which can be selected using lineSetCallTreatment). The value will be dwNumCallTreatments
times SIZEOF (LINECALLTREATMENTENTRY).
dwDeviceClassesSize
dwDeviceClassesOffset
Length in
bytes and offset from the beginning of LINEADDRESSCAPS of a string
consisting of the device class identifiers supported on this address for use
with lineGetID,
separated by nulls; the last class indentifier is followed by two nulls.
dwMaxCallDataSize
The maximum
number of bytes that an application can set in LINECALLINFO using lineSetCallData.
dwCallFeatures2
Specifies additional
switching capabilities or features available for all calls on this address
using the LINECALLFEATURE2_ constants. It is an extension of the dwCallFeatures
member.
dwMaxNoAnswerTimeout
The maximum
value in seconds that can be set in the dwNoAnswerTimeout member in LINECALLPARAMS when making a call. A value
of 0 indicates that automatic abandonment of unanswered calls is not supported
by the service provider, or that the timeout value is not adjustable by
applications.
dwConnectedModes
Specifies the
LINECONNECTEDMODE_ values that may appear in the dwCallStateMode member
of LINECALLSTATUS
and in LINE_CALLSTATE
messages for calls on this address.
dwOfferingModes
Specifies the
LINEOFFERINGMODE_ values that may appear in the dwCallStateMode member
of LINECALLSTATUS and in LINE_CALLSTATE messages for calls on this
address.
dwAvailableMediaModes
Indicates the
media modes that can be invoked on new calls created on this address, when the dwAddressFeatures
member indicates that new calls are possible. If this field is zero, it
indicates that the service provider either does not know or cannot indicate
which media modes are available, in which case any or all of the media modes
indicated in the dwMediaModes field in LINEDEVCAPS may be available.
Remarks
Device-specific
extensions should use the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset)
variably sized area of this data structure.
Older
applications will have been compiled without this field in the LINEADDRESSCAPS
structure, and using a SIZEOF LINEADDRESSCAPS smaller than the
new size. The application passes in a dwAPIVersion parameter with the lineGetAddressCaps function, which can be used
for guidance by TAPI in handling this situation. If the application passes in a
dwTotalSize less than the size of the fixed portion of the structure as
defined in the dwAPIVersion specified, LINEERR_STRUCTURETOOSMALL will be
returned. If sufficient memory has been allocated by the application, before
calling TSPI_lineGetAddressCaps, TAPI will set the dwNeededSize
and dwUsedSize fields to the fixed size of the structure as it existed
in the specified API version.
New service
providers (which support the new API version) must examine the API version
passed in. If the API version is less than the highest version supported by the
provider, the service provider must not fill in fields not supported in older
API versions, as these would fall in the variable portion of the older
structure.
New
applications must be cognizant of the API version negotiated, and not examine
the contents of fields in the fixed portion beyond the original end of the
fixed portion of the structure for the negotiated API version.
The members dwPredictiveAutoTransferStates
through dwAvailableMediaModes are available only to applications that
request an API version of 0x00020000 or greater when calling lineGetAddressCaps.
See Also