CHString::GetAt(int) method (chstring.h)

Article
02/22/2024

[The CHString class is part of the WMI Provider Framework which is now considered in final state, and no further development, enhancements, or updates will be available for non-security related issues affecting these libraries. The MI APIs should be used for all new development.]

The GetAt method returns a single character specified by an index number.

Syntax

WCHAR GetAt(
  int nIndex
);

Parameters

nIndex

Zero-based index of the character in the CHString string.

Note The nIndex parameter must be greater than or equal to zero (0), and less than the value returned by GetLength. The debug version of the CHString library validates the bounds of nIndex; the release version does not.

Return value

Returns a WCHAR that contains the character at the specified place in the string.

Remarks

The overloaded subscript ([]) operator is a convenient alternative for GetAt.

Examples

The following code example shows the use of CHString::GetAt:

CHString s( L"abcdef" );
assert( s.GetAt(2) == 'c' );

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	chstring.h (include FwCommon.h)
Library	FrameDyn.lib
DLL	FrameDynOS.dll; FrameDyn.dll