CComSafeArrayBound クラス

このクラスは、SAFEARRAYBOUND 構造体のラッパーです。

構文

class CComSafeArrayBound : public SAFEARRAYBOUND

メンバー

メソッド

機能	説明
CComSafeArrayBound	コンストラクター。
GetCount	このメソッドを呼び出すと、要素の数が返されます。
GetLowerBound	このメソッドを呼び出すと、下限が返されます。
GetUpperBound	このメソッドを呼び出すと、上限が返されます。
SetCount	要素の数を設定するには、このメソッドを呼び出します。
SetLowerBound	下限を設定するには、このメソッドを呼び出します。

演算子

演算子	説明
operator =	CComSafeArrayBound を新しい値に設定します。

解説

このクラスは、CComSafeArray によって使用される SAFEARRAYBOUND 構造体のラッパーです。 1 次元の CComSafeArray オブジェクトの上限と下限、および含まれる要素の数を照会および設定するためのメソッドが提供されます。 多次元の CComSafeArray オブジェクトでは、CComSafeArrayBound オブジェクトの配列を使います (1 次元ごとに 1 つ)。 したがって、GetCount などのメソッドを使う場合は、このメソッドが多次元配列内の要素の総数を返さない点に注意してください。

ヘッダー: atlsafe.h

必要条件

ヘッダー: atlsafe.h

CComSafeArrayBound::CComSafeArrayBound

コンストラクター。

CComSafeArrayBound(ULONG ulCount = 0, LONG lLowerBound = 0) throw();

パラメーター

ulCount
配列内の 要素の数。

lLowerBound
配列の番号付けを開始する下限。

解説

配列に C++ プログラムからアクセスする場合は、下限を 0 として定義することをお勧めします。 配列を他の言語 (Visual Basic など) で使う場合は、別の下限値を使用する方が望ましいことがあります。

CComSafeArrayBound::GetCount

このメソッドを呼び出すと、要素の数が返されます。

ULONG GetCount() const throw();

戻り値

要素の数を返します。

解説

関連付けられた CComSafeArray オブジェクトが多次元配列を表す場合、このメソッドでは右端の次元の要素の総数だけが返されます。 要素の総数を取得するには、CComSafeArray::GetCount を使います。

CComSafeArrayBound::GetLowerBound

このメソッドを呼び出すと、下限が返されます。

LONG GetLowerBound() const throw();

戻り値

CComSafeArrayBound オブジェクトの下限を返します。

CComSafeArrayBound::GetUpperBound

このメソッドを呼び出すと、上限が返されます。

LONG GetUpperBound() const throw();

戻り値

CComSafeArrayBound オブジェクトの上限を返します。

解説

上限は、要素の数と下限値に依存します。 たとえば、下限が 0 で、要素の数が 10 の場合、上限は自動的に 9 に設定されます。

CComSafeArrayBound::operator =

CComSafeArrayBound を新しい値に設定します。

CComSafeArrayBound& operator= (const CComSafeArrayBound& bound) throw();
CComSafeArrayBound& operator= (ULONG ulCount) throw();

パラメーター

bound
CComSafeArrayBound オブジェクト。

ulCount
要素の数。

戻り値

CComSafeArrayBound オブジェクトへのポインターを返します。

解説

CComSafeArrayBound オブジェクトは、既存の CComSafeArrayBound を使って代入するか、要素の数を指定して代入することができます。その場合、下限は既定で 0 に設定されます。

CComSafeArrayBound::SetCount

要素の数を設定するには、このメソッドを呼び出します。

ULONG SetCount(ULONG ulCount) throw();

パラメーター

ulCount
要素の数。

戻り値

CComSafeArrayBound オブジェクト内の要素の数を返します。

CComSafeArrayBound::SetLowerBound

下限を設定するには、このメソッドを呼び出します。

LONG SetLowerBound(LONG lLowerBound) throw();

パラメーター

lLowerBound
下限。

戻り値

CComSafeArrayBound オブジェクトの新しい下限を返します。

解説

配列に Visual C++ プログラムからアクセスする場合は、下限を 0 として定義することをお勧めします。 配列を他の言語 (Visual Basic など) で使う場合は、別の下限値を使用する方が望ましいことがあります。

上限は、要素の数と下限値に依存します。 たとえば、下限が 0 で、要素の数が 10 の場合、上限は自動的に 9 に設定されます。

関連項目

クラスの概要