Using FaxHeadLine

In fax applications, there are several properties of a call object that control fax behaviour, incuding FaxHeadLine. 

This is used in the VB sample "OutgoingFax" (Basic\samples\VisualBasic\Outgoing_Fax) like this:

'create a call object Set FaxCall = CreateObject("DivaSDK.DivaCall")      'set the fax headline for the call FaxCall.FaxHeadLine = "Diva Server SDK: Send by Visual Basic Simpla Fax Sample"

 

Hint

you can load a VB '.FRM' file with a text editor to read the source code

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:

retVal = FaxCall.Connect(PhoneNumber.Text, DivaCallType_Fax) If (retVal = DivaResultSuccess) Then

 
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.

Return to Documentation Home I Return to Sangoma Support