Previous PageTable Of Contents../index.htmlIndexNext Page

cc_SetUsrAttr( )

Description | Cautions | Example | Errors | See Also

Name:

int cc_SetUsrAttr(linedev, usrattr)

Inputs:

LINEDEV linedev

  line device handle

 

long usrattr

  user attribute information

Returns:

0 on success
< 0 on failure

Includes:

cclib.h

Category:

System tools

Mode:

synchronous

Technology:

BRI/2; BRI/SC; PRI

Top Of PageDescription

The cc_SetUsrAttr( ) function sets the user attribute for a line device for later retrieval. The user attribute value can be a memory pointer used to identify a board and a channel on a board. The value can also be a pointer to a user-defined structure such as the current state or the active call reference number.

For example, the application can use the first two digits to identify a board and the last two digits to identify a channel on a board, with a '0' inserted between the numbers to separate them. The number '12024' would indicate the 24th channel on board 12.

Parameter

Description

linedev:

The line device handle.

usrattr:

The user-defined attribute. Applications can recall this number by calling the cc_GetUsrAttr( ) function.

Top Of PageCautions

None

Top Of PageExample

Top Of PageErrors

If the function returns < 0 to indicate failure, use the cc_CauseValue( ) function to retrieve the reason code for the failure. The cc_ResultMsg( ) function can be used to interpret the reason code. Error codes are defined in the files ccerr.h, isdnerr.h, and isdncmd.h.

Typically, a < 0 return code for the cc_SetUsrAttr( ) function indicates that the function reference (the device handle) is not valid for the function call.

Top Of PageSee Also


Previous PageTable Of ContentsTop Of PageIndexNext Page

Click here to contact Dialogic Customer Engineering

Copyright 2001, Dialogic Corporation
All rights reserved
This page generated December, 2001