Return the municipal bond's (compounded) yield.

The bond's settlement date and theoretical price are used within the calculation.

The Bond object that is to be queried must have been previously created via the FixedMuniBond(), FixedMuniBond_y() or FixedMuniBond_p() functions.

These functions would have returned a string 'KEY' which is to be passed to the 'MuniBondKey' parameter of this function.

Please refer to the large number of enumeration functions present within the CapeTools Enums category of functions.

The CapeTools Enums category of functions return correct string codes that can be passed to parameters taking fixed string values defined by the library (ie - DayCount codes, frequency codes, currency codes, compounding codes, business day convention codes etc...).

You can thus execute these enumeration functions which return the proper code, instead of trying to remember the string code needed or making spelling mistakes which can be difficult to debug.

Double CTMunicipalBonds.MuniBNDYield( _
String MuniBNDKey, _
FreqEnum QuoteFreq, _
DayCountEnum dayCounter)

=CT.MUNIBOND.Yield(
Excel String Cell MuniBNDKey,
Excel String Cell QuoteFreq,
Excel String Cell dayCounter)

static double MuniBNDYield(
std::string MuniBNDKey,
FreqEnum QuoteFreq,
DayCountEnum dayCounter);

System.Double CTMunicipalBondsSA.MuniBNDYield(
System.String MuniBNDKey,
CTIEnums.FreqEnum QuoteFreq,
CTIEnums.DayCountEnum dayCounter);

The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.