Show / Hide Table of Contents

CheckIndexBounds Method

The unique error ID to use if an exception needs to be thrown.

The name of the parameter that contains the index value to check.

The actual index value to verify.

The current total of elements in the collection against which to verify the index value.

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

Syntax

'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 family

Reference

FCArgumentException Class
FCArgumentException Members

Back to top © 2022 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.