str = MoonPhaseSymbol(nMoonPhaseIndex, bUseSymbolFont)

This macro function returns the symbol character of the Moon phase as specified in the current moon and sun options as shown in the image on the right for the [mp] and [mt] tokens, and corresponding to the value nMoonPhaseIndex.

➢If you supply the value of nMoonPhaseIndex yourself, be sure to supply the correct index, as described here otherwise you will trigger message 177665.

If the value of bUseSymbolFont is true, then the result of this function will be wrapped in the formatting tags **RICH** and **TEXT** which, during diary generation will be used to apply the symbol font of Moon phases for the current script.

This value of nMoonPhaseIndex could have come from a previous call to MoonPhaseOf as shown in the example below.

nMoonPhaseIndex = MoonPhaseOf(nDate, 1, false)
switch nMoonPhaseIndex
   case 0
      sRESULT = 'No moon phase today'
   else
      sRESULT = MoonPhaseSymbol(nMoonPhaseIndex, true) + ' ' + MoonPhaseName(nMoonPhaseIndex)
endswitch

See also: MoonPhaseAndTimeOf, MoonPhaseOf, MoonPhaseName.

Topic 177655, last updated on 11-Oct-2026