lineGetLineDevStatus

Last Updated : Sep 03, 2015 |

This function lineGetLineDevStatus returns a device specific buffer.

LONG
WINAPI
lineGetLineDevStatus(
HLINE hLine, 
LPLINEDEVSTATUS lpLineDevStatus 
); 
Note:

IP Office 4.1+ includes a number of additional fields described in the following table. If you are using the TAPI interface you might need to increase the size of message receive buffers for the lineDevStatus message to allow for new fields. The required increase in length is 16*(2+ number of user rights groups defined on the IP Office).

The dev specific buffer contains the following information:

Byte

Contains

Notes

0.n

Phone Extension

This line number is monitored as a character string. For example "217".

n+1

0

Null terminator for the string.

n+2

Forward on busy

Set the value to 1 if the phone is set to forward on busy. Otherwise set the value to 0.

n+3

Forward on no answer

Set the value to 1 if the phone is set to forward on no answer. Otherwise set the value to 0.

n+4

Forward unconditional

Set the value to 1 if the phone is set to forward all.

n+5

Forward hunt group flag

Set the value to 1 if the phone is set to forward hunt group calls.

n+6

Do Not Disturb

Set the value to 1 if the phone is set to Do Not Disturb.

n+7

Outgoing call bar flag

Set the value to 1 if the phone is barred from making external calls.

n+8

Call waiting on flag

Set the value to 1 if call waiting is enabled for this phone.

n+9

Voice mail on flag

Set the value to 1 if voice mail is enabled for this phone.

n+10

Voice mail ring-back flag

Set the value to 1 if voice mail ring back is enabled for this phone.

n+11

Number of read voice mail messages

The number of read messages.

n+12

Number of unread voice mail messages

The number of voice mail messages waiting for the user.

n+13

Outside call sequence number

Type of ring for external calls.

n+14

Inside call sequence number

Type of ring for internal calls.

n+15

Ring back sequence number

Type of ring for ring back calls.

n+16

No answer time out period

Number of seconds the phone rings before following the no answer action . An example of an action is to forward on no answer and divert to voice mail.

n+17

Wrap up time period

Number of seconds the phone is unable to accept calls after a call.

n+18

Can intrude flag

Set the value to 1 if the phone can intrude upon calls.

n+19

Cannot be intruded upon flag

Set the value to 1 if the phone cannot intruded upon.

n+20

X directory flag

Set the value to 1 if the user does not display in the internal directory.

n+21

Force login flag

The phone is logged out when it starts. The user must log in manually.

n+22

Forced account code flag

Set the value to 1 if the phone is forced to provide a valid account code when making external calls.

n+23

Login code flag

Set the value to 1 if the user has a login code configured.

n+24

System phone flag

Set the value to 1 if this is a system phone.

n+25

Absent message ID

The ID of the absent message.

n+26

Absent message set flag

Set the value to 1 if the absent message with the ID in the previous field is displayed on the phone.

n+27

Voice mail email mode

Set the value to 1 if voice mail email mode is enabled.

n+28..m

Extn

The user extension, might be different from the phone extension.

m+1

0

Null terminator for Extn string.

m+2..p

locale

The locale of the user.

p+1

0

Null terminator of locale.

p+2..q

Forward destination

The number that the phone is set to divert to.

q+1

0

Null terminator for forward destination.

q+2..r

Follow me number

All calls are redirected to this number.

r+1

0

r+2..s

Absent text

The absent text defined for this phone.

s+1

0

s+2..t

Do not disturb exception list

A list of numbers that are permitted to call while the phone is in the Do Not Disturb state. Each number is a null-terminated string. The last number in the list is terminated by two nulls. The Field t+1 represents the second of these two nulls. If the list is empty, then the data contains a single null which is represented by t+1.

t+1

0

t+2..u

Forward on busy number

The number to which calls are redirected when the phone is busy.

u+1

0

u+2

User's priority

The priority associated with all calls made by this user.

u+3

Group membership

This byte contains the number of groups in which the user is currently enabled.

u+4

Groups out of time

Number of groups that the user is a member of that are currently outside their time profile.

u+5

Disabled groups

Number of groups from which the user is currently disabled.

u+6

Groups out of service

Number of groups that the user is a member of that are currently out of service.

u+7

Night service groups

Number of groups that the user is a member of that are currently on night service.

Additional fields available for IP Office 4.1+.

v+8..v

Working Hours User Rights Group Name

Set to blank by default, meaning there are no restrictions to rights. This field enables selection of user rights which might set and lock some user settings. If a Working Hours Time Profile is selected, the Working Hours User Rights are only applied during the times defined by that time profile. Otherwise, they are applied at all times.

Maximum length is 15 characters.

v+1

0

Null termination for working hours group name.

V+2

Out of Hours User Rights Group Name

Set to blank by default, meaning there are no restrictions to rights. This field enables selection of alternate user rights that are used outside the times defined by the users Working Hours Time Profile.

Maximum length is 15 characters.

v…w

0

Null termination for working hours group name.

w+1..x

User Restriction Name List

A list of all User Restriction Group Names defined on the IP Office.

Each name is a maximum of 15 characters long and is null terminated.

This list enables the TAPI application to present the list of valid values to which the previous two fields can be set. For example in a Combo Box control.

x+1

0

Null termination (empty string) of name list.