Previous PageTable Of Contents../index.htmlIndexNext Page

cc_ResultMsg( )

Description | Caution | Example | Errors | See Also

Name:

int cc_ResultMsg(linedev, ResultCode, msg)

Inputs:

LINEDEV linedev

  line device handle

 

int ResultCode

  function return value

 

char **msg

  pointer to the address where the result message is stored

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

cc_ResultMsg( ) is a convenience function that interprets the function return code. The cc_ResultMsg( ) function retrieves either the cause value of an event from the cc_CauseValue( ) function or the function return code from the cc_ResultValue( ) function.

Parameter

Description

linedev:

The line device handle.

ResultCode:

The cause value of the event or return code (retrieved from cc_ResultValue( ) or cc_CauseValue( )).

msg:

The pointer to the buffer address where the result message will be stored.

Top Of PageCaution

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. Error codes are defined in the files ccerr.h, isdnerr.h, and isdncmd.h.

Typically, a < 0 return code for the cc_ResultMsg( ) function indicates that the function reference (the line device number) 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