CComboBox::CompareItem

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

並べ替え後のオーナー描画コンボボックス内の新しいリスト項目の相対位置を調べるために、フレームワークによって呼び出されます

virtual int CompareItem(
   LPCOMPAREITEMSTRUCT lpCompareItemStruct 
);

パラメータ

lpCompareItemStruct
COMPAREITEMSTRUCT 構造体への long 型のポインタ。

戻り値

COMPAREITEMSTRUCT 構造体に記述された 2 つの項目の相対位置を返します。次のいずれかの値になります。

値	説明
– 1	並べ替え後の項目 1 の位置は、項目 2 の前になります。
0	並べ替え後の項目 1 の位置は、項目 2 と同じになります。
1	並べ替え後の項目 1 の位置は、項目 2 の後ろになります。

COMPAREITEMSTRUCT 構造体については、「CWnd::OnCompareItem」を参照してください。

解説

既定では、このメンバ関数は何も実行しません。オーナー描画コンボボックスを LBS_SORT スタイルで作成したときは、リストボックスに追加された新しい項目をフレームワークが並べ替えることができるように、このメンバ関数をオーバーライドする必要があります。

使用例

// CMyComboBox is my owner-drawn combo box derived from CComboBox. This 
// example compares two items using strcmp to sort items in reverse 
// alphabetical order. The combo box control was created with the 
// following code:
//   pmyComboBox->Create(
//      WS_CHILD|WS_VISIBLE|WS_BORDER|WS_HSCROLL|WS_VSCROLL|
//      CBS_SORT|CBS_OWNERDRAWVARIABLE,
//      myRect, pParentWnd, 1);
//
int CMyComboBox::CompareItem(LPCOMPAREITEMSTRUCT lpCompareItemStruct)
{
   int iComp = 0;
   ASSERT(lpCompareItemStruct->CtlType == ODT_COMBOBOX);
   LPCTSTR lpszText1 = (LPCTSTR) lpCompareItemStruct->itemData1;
   ASSERT(lpszText1 != NULL);
   LPCTSTR lpszText2 = (LPCTSTR) lpCompareItemStruct->itemData2;
   ASSERT(lpszText2 != NULL);

   if (NULL != lpszText1 && NULL != lpszText2)
   {
      iComp = _tcscmp(lpszText2, lpszText1);    
   }

   return iComp;
}