Previous PageTable Of Contents../index.htmlIndexNext Page

cc_GetUsrAttr( )

Description | Cautions | Example | Errors | See Also

Name:

int cc_GetUsrAttr(linedev, usr_attr)

Inputs:

LINEDEV linedev

  line device handle

 

long *usr_attr

  user attribute information

Returns:

0 on success
< 0 on failure

Includes:

cclib.h

Category:

System tools

Mode:

synchronous

Technology:

BRI/2; BRI/SC; PRI (all protocols)

Top Of PageDescription

The cc_GetUsrAttr( ) function gets the established attribute for the line device. The attributes are user defined and are established using the cc_SetUsrAttr( ) function. The user attribute value can be a memory pointer used to identify a board and a channel on a board, or a pointer to a user-defined structure such as the current state or the active call reference number.

Parameter

Description

linedev:

The line device handle.

usr_attr:

The location where the returned user attribute will be stored.

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_GetUsrAttr( ) 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