CheckIndexBounds Method

Used to verify that an indexer property get on a collection object contains an index that is within the bounds of collection.

Syntax

Visual Basic
C#

'Declaration
 
Public Shared Sub CheckIndexBounds( _
   ByVal errorId As Integer, _
   ByVal paramName As String, _
   ByVal index As Integer, _
   ByVal maxBound As Integer _
)

public static void CheckIndexBounds( 
   int errorId,
   string paramName,
   int index,
   int maxBound
)

Parameters

errorId: The unique error ID to use if an exception needs to be thrown.
paramName: The name of the parameter that contains the index value to check.
index: The actual index value to verify.
maxBound: The current total of elements in the collection against which to verify the index value.

Exceptions

Exception	Description
FCArgumentException	index was greater than or equal to maxBound.

Remarks

Index is expected to be a zero-based index value into the collection. If index is greater than or equal to maxBound, an FCArgumentException will be thrown using the error ID supplied.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Reference

FCArgumentException Class
FCArgumentException Members

© 2010 Dovetail Software, Inc. - All rights reserved.
- Clarify, Amdocs, and related products and names are copyright and trademark of Amdocs, Inc.
- .NET, Visual Studio.NET, C#, Visual Basic and related products are trademark of Microsoft corporation.

Send comments on this topic.