WorksheetFunction.CumPrinc Method

  • Article

Returns the cumulative principal paid on a loan between start_period and end_period.

Namespace:  Microsoft.Office.Interop.Excel
Assembly:  Microsoft.Office.Interop.Excel (in Microsoft.Office.Interop.Excel.dll)

Syntax

'Declaration
Function CumPrinc ( _
    Arg1 As Object, _
    Arg2 As Object, _
    Arg3 As Object, _
    Arg4 As Object, _
    Arg5 As Object, _
    Arg6 As Object _
) As Double
'Usage
Dim instance As WorksheetFunction
Dim Arg1 As Object
Dim Arg2 As Object
Dim Arg3 As Object
Dim Arg4 As Object
Dim Arg5 As Object
Dim Arg6 As Object
Dim returnValue As Double

returnValue = instance.CumPrinc(Arg1, _
    Arg2, Arg3, Arg4, Arg5, Arg6)

double CumPrinc(
    Object Arg1,
    Object Arg2,
    Object Arg3,
    Object Arg4,
    Object Arg5,
    Object Arg6
)

Parameters

  • Arg4
    Type: System.Object

    The first period in the calculation. Payment periods are numbered beginning with 1.

Return Value

Type: System.Double

Remarks

The following tables lists values used in Arg6.

Type

Timing

0 (zero)

Payment at the end of the period

1

Payment at the beginning of the period

Make sure that you are consistent about the units you use for specifying rate and nper. If you make monthly payments on a four-year loan at an annual interest rate of 12 percent, use 12%/12 for rate and 4*12 for Arg2. If you make annual payments on the same loan, use 12% for rate and 4 for Arg2.

Arg2, Arg4, Arg5, and type are truncated to integers.

If rate ≤ 0, Arg2 ≤ 0, or Arg3 ≤ 0, CumPrinc generates an error.

If Arg4 < 1, Arg5 < 1, or Arg4 > Arg5, CumPrinc generates an error.

If Arg6 is any number other than 0 or 1, CumPrinc generates an error.

See Also

Reference

WorksheetFunction Interface

WorksheetFunction Members

Microsoft.Office.Interop.Excel Namespace