lineReleaseUserUserInfo  58C3H9 

The lineReleaseUserUserInfo function informs the service provider that the application has processed the user-to-user information contained in the LINECALLINFO5R_QHB structure, and that subsequently received user-to-user information can now be written into that structure. The service provider will send a LINE_CALLINFO message indicating LINECALLINFOSTATE_USERUSERINFO when new information is available.

LONG lineReleaseUserUserInfo(

    HCALL hCall

 

   );

 

 

Parameters

hCall

A handle to the call. The application must be an owner of the call. The call state of hCall can be any state.

 

Return Values

Returns a positive request ID if the function will be completed asynchronously or a negative error number if an error has occurred. The dwParam2 parameter of the corresponding LINE_REPLY2_C_9WS message is zero if the function is successful or it is a negative error number if an error has occurred. Possible return values are:

LINEERR_INVALCALLHANDLE, LINEERR_OPERATIONFAILED, LINEERR_NOMEM, LINEERR_RESOURCEUNAVAIL, LINEERR_NOTOWNER, LINEERR_UNINITIALIZED, LINEERR_OPERATIONUNAVAIL.

Remarks

The lineReleaseUserUserInfo function allows the application to control the flow of incoming user-user information on an ISDN connection. When a new, complete user-user information message is received, the service provider informs the application using a LINE_CALLINFO1IIEDCM message (specifying LINECALLINFOSTATE_USERUSERINFO). Any number of applications may examine the information (using lineGetCallInfo1UPWZV0), but the application owning the call controls when the information is released so that subsequent information can be reported. The service provider will not overwrite previous user-user information in LINECALLINFO with newer information until after lineReleaseUserUserInfo has been called. It is the responsibility of the service provider to buffer subsequently received user-user information until the previous information is released by the application owning the call.

Although this is a new function which older applications would not be expected to call, for backward compatibility, they should not be prevented from doing so. The function will work the same way for all applications.

See Also

LINE_CALLINFO, LINE_REPLY, LINECALLINFO, lineGetCallInfo