Returns the relevant underlying date's period multiplier within the american Exercise object.

The XPath query which can also be passed to the FpMLGenericQuery() function to generate the same result is : //descendant::Swaption/americanExercise[1]/relevantUnderlyingDate[1]/relativeDates[1]/periodMultiplier/text(). This function requires the input of a FpMLDoc object key, which must have been produced via a call to the ReadFpML() function.

This function would have returned a string 'KEY' which is to be passed to the 'FpMLDocKey' parameter of this function.

If you were looking at the FpML document, a typical example of walking to this(these) node(s) would be...

  // FpML Document -> Swaption

    -> americanExercise[1]

      -> relevantUnderlyingDate[1]

        -> relativeDates[1]

          -> periodMultiplier

            -> return( nodeValue(s) )

Or if using the FpMLGenericQuery() function...

//descendant::Swaption/americanExercise[1]/relevantUnderlyingDate[1]/relativeDates[1]/periodMultiplier/text()

Long CTFpMLOS.AmerRelevantUnderlyingDateMultiplier( _
String FpMLDocKey)

=CT.FpML.OS.AmerRelevantUnderlyingDateMultiplier(
Excel String Cell FpMLDocKey)

static long AmerRelevantUnderlyingDateMultiplier(
std::string FpMLDocKey);

System.Int32 CTFpMLOSSA.AmerRelevantUnderlyingDateMultiplier(
System.String FpMLDocKey);