GetHolTextFromTable

Navigation:  Appendices > Macro Language > Built-in Functions > All Functions (Alphabetical) >

GetHolTextFromTable

Previous pageReturn to chapter overviewNext page

str = GetHolTextFromTable(bFullText)

 

This macro function returns the plain text part of the name of the current holiday in the holidays table.

 

// initialize the holidays table

Reset_FindHolidayOnDate()

// check if there is a holiday today containing 'luther'

if FindHolidayOnDate(Today(), nHolSet)

 sText = GetHolTextFromTable()

 if pos('luther', sText) > 0

         // do something special

 endif

endif

 

If you need to get the formatted text of a holiday name, with bold italic etc... attributes, you should use the GetHolNameFromTable function instead.

 

Note :

The functions GetHolDateFromTable, GetHolIdFromTable, GetHolTextFromTable, and GetHolNameFromTable are used to read information about the current holiday record in the holidays table. If you need to get the value of a holidays list token, you should use the EvalToken function.

To set the current record to a desired holiday occurrence you would use one of the functions such as : FindHolidayOnDate or GetDateForHolidayIdOfYear.

 

This function is part of a set of advanced functions that give you direct access to the holidays tables (see Using Built-in Holidays Functions).


Topic 110054 updated on 01-Nov-2016.
Topic URL: http://www.qppstudio.net/webhelp/index.html?getholidaytext.htm