- Home
- Services & Support
- Downloads
- Helpweb
- Dialogic API information
- Find a Dialogic API
- DM3 & JCT Media Boards
- Host Media Processing (HMP)
- Global Call API
- Brooktrout Fax
- IP Media Server
- CSP / MSP / IMG
- DMG-series Media Gateways
- Signaling products
- Global Call API
- Multimedia Platform for ATCA
- Diva Media Boards
- Diva SDK
- Diva Client
- Eiconcards (X.25)
- Other products
- Online Training
- Manuals
- Contact
Dialogic Support Helpweb
Dialogic® Diva® SDK
Using FaxHeadLine (Diva Component API)
In fax applications, there are several properties of a call object that control fax behaviour, incuding FaxHeadLine.This is used in the VB 6 sample "OutgoingFax" (Basic\samples\VisualBasic\Outgoing_Fax) like this:
VB 6:
'create a call object
Set FaxCall = CreateObject("DivaSDK.DivaCall")
'set the fax headline for the call
FaxCall.FaxHeadLine = "Diva Server SDK: Sent by Simple Fax Sample"
VB 2005:
'create a call object Dim FaxCall As DivaCall = New DivaCall() 'set the fax headline for the call FaxCall.FaxHeadLine = "Diva Server SDK: Sent by Simple Fax Sample"C#:
// create a call object DivaCall FaxCall = (DivaCall) new DivaCall(); // set the fax headline for the call FaxCall.FaxHeadLine = "Diva Server SDK: Sent by Simple Fax Sample";Creating the call object does not make a call. This needs to be done explicitly later in the application using the 'object.Connect' function/method: VB 6:
retVal = FaxCall.Connect(PhoneNumber.Text, DivaCallType_Fax) If (retVal = DivaResultSuccess) ThenVB 2005:
Dim retval As DivaResultCodes retVal = FaxCall.Connect(PhoneNumber.Text, DivaCallTypes.DivaCallType_Fax) If (retVal = DivaResultCodes.DivaResultSuccess) ThenC#:
DivaResultCodes retval;
retVal = FaxCall.Connect(PhoneNumber.Text, DivaCallTypes.DivaCallType_Fax);
if (retVal == DivaResultCodes.DivaResultSuccess)
{
The fax headline cannot be changed once the fax call has been established, so you have to set
FaxHeadLine before you issue the 'Connect'.
For example, if you add some code like this after the 'if' statement above:
FaxCall.FaxHeadLine = "This fax headline does not appear"this does not cause a runtime error, but is simply ignored. The received fax will still have the original FaxHeadLine text.
