DiaGlobWrapper.CanHangup Method

DiaGlobWrapperCanHangup Method

diaGlobWrapper Help

Convenience function to invoke before using HangUp(). This is to avoid an exception if the channel is not in the right state.

Namespace: Inkostar
Assembly: DiaGlobWrapper (in DiaGlobWrapper.dll) Version: 0.0.0.0

Syntax

C++

Copy

public bool CanHangup(
	Channel CurrentChannel
)

Public Function CanHangup ( 
	CurrentChannel As Channel
) As Boolean

public:
bool CanHangup(
	Channel^ CurrentChannel
)

member CanHangup : 
        CurrentChannel : Channel -> bool

Parameters

CurrentChannel: Type: InkostarChannel
The Channel on the Dialogic board on which the function is to be executed.

Return Value

Type: Boolean
Returns True if the channel is in a state where HangUp can be invoked. Otherwise False is returned.

Remarks

This function can be invoked anytime.
Compatibility: All.
On failure this function will generate an exception of type DiaGlobWrapperLibException

Examples

To check if the channel can be issued with a HangUp request:
C#: if (objDevice.CanHangup(ChannelInbound)){objDevice.HangUp(ChannelInbound);}
VB.NET: If objDevice.CanHangup(ChannelInbound) Then objDevice.HangUp(ChannelInbound)

Reference

DiaGlobWrapper Class

Inkostar Namespace