bsearch_sbsearch_s

並べ替えられた配列のバイナリ検索を実行します。Performs a binary search of a sorted array. これは、「CRT のセキュリティ機能」の説明にあるとおり、セキュリティが強化されたバージョンの bsearch です。This is version of bsearch with security enhancements as described in Security Features in the CRT.

構文Syntax

void *bsearch_s(
   const void *key,
   const void *base,
   size_t number,
   size_t width,
   int ( __cdecl *compare ) ( void *, const void *key, const void *datum),
   void * context
);

パラメーターParameters

keykey
検索するオブジェクト。Object to search for.

basebase
検索データのベースへのポインター。Pointer to base of search data.

numbernumber
要素の数。Number of elements.

widthwidth
要素の幅。Width of elements.

comparecompare
2 つの要素を比較するコールバック関数。Callback function that compares two elements. 最初の引数は、コンテキストポインター。The first argument is the context pointer. 2 番目の引数がへのポインター、キー検索します。The second argument is a pointer to the key for the search. 3 番目の引数と比較する配列要素へのポインターは、キーします。The third argument is a pointer to the array element to be compared with key.

contextcontext
比較関数内でアクセスできるオブジェクトへのポインター。A pointer to an object that can be accessed in the comparison function.

戻り値Return Value

bsearch_sの発生個所へのポインターを返しますキーが指す配列で基本します。bsearch_s returns a pointer to an occurrence of key in the array pointed to by base. 場合キーが見つからない、関数を返しますNULLします。If key is not found, the function returns NULL. 配列が昇順でないか、同一キーで重複するレコードがある場合、結果は予測不可能になります。If the array is not in ascending sort order or contains duplicate records with identical keys, the result is unpredictable.

この関数に無効なパラメーターが渡されると、「 Parameter Validation」で説明されているように、無効なパラメーター ハンドラーが呼び出されます。If invalid parameters are passed to the function, the invalid parameter handler is invoked as described in Parameter Validation. 続けるには、実行が許可された場合errnoに設定されているEINVAL 、関数を返しますNULLします。If execution is allowed to continue, errno is set to EINVAL and the function returns NULL. 詳細については、「errno、_doserrno、_sys_errlist、_sys_nerr」をご覧ください。For more information, see errno, _doserrno, _sys_errlist, and _sys_nerr.

エラー条件Error Conditions

keykey basebase comparecompare numbernumber widthwidth errnoerrno
NULLNULL 任意any 任意any 任意any 任意any EINVALEINVAL
任意any NULLNULL 任意any != 0!= 0 任意any EINVALEINVAL
任意any 任意any 任意any 任意any = 0= 0 EINVALEINVAL
任意any 任意any NULLNULL 1 つan 任意any EINVALEINVAL

RemarksRemarks

Bsearch_s関数の並べ替え済み配列のバイナリ検索を実行するの各要素は、サイズ (バイト)。The bsearch_s function performs a binary search of a sorted array of number elements, each of width bytes in size. 基本値は、検索対象の配列のベースへのポインターとキー検索されている値です。The base value is a pointer to the base of the array to be searched, and key is the value being sought. 比較パラメーターを配列要素への要求されたキーを比較し、それらの関係を指定する値は次のいずれかを返しますユーザー指定のルーチンへのポインターです。The compare parameter is a pointer to a user-supplied routine that compares the requested key to an array element and returns one of the following values specifying their relationship:

によって返される値比較ルーチンValue returned by compare routine 説明Description
< 0< 0 キーは配列要素より小さい。Key is less than array element.
00 キーは配列要素と等しい。Key is equal to array element.
> 0> 0 キーは配列要素より大きい。Key is greater than array element.

コンテキスト検索対象のデータ構造体は、オブジェクトの一部との比較関数は、オブジェクトのメンバーにアクセスする必要がある場合、ポインターが便利な可能性があります。The context pointer may be useful if the searched data structure is part of an object, and the compare function needs to access members of the object. 比較関数はそのオブジェクトの適切なオブジェクトの種類とアクセスのメンバーに void ポインターをキャストすることがあります。The compare function may cast the void pointer into the appropriate object type and access members of that object. 追加、コンテキストパラメーターにより、 bsearch_s追加のコンテキストに関連付けられたデータを使用できるようにする静的変数を使用して、再入バグを回避するのに使用できるためより安全な比較関数。The addition of the context parameter makes bsearch_s more secure since additional context may be used to avoid reentrancy bugs associated with using static variables to make data available to the compare function.

必要条件Requirements

ルーチンによって返される値Routine 必須ヘッダーRequired header
bsearch_sbsearch_s <stdlib.h> および <search.h><stdlib.h> and <search.h>

互換性の詳細については、「 互換性」を参照してください。For additional compatibility information, see Compatibility.

Example

このプログラムでは、 qsort_sで文字列の配列を並べ替え、bsearch_s を使用して "cat" という単語を検索します。This program sorts a string array with qsort_s, and then uses bsearch_s to find the word "cat".

// crt_bsearch_s.cpp
// This program uses bsearch_s to search a string array,
// passing a locale as the context.
// compile with: /EHsc
#include <stdlib.h>
#include <stdio.h>
#include <search.h>
#include <process.h>
#include <locale.h>
#include <locale>
#include <windows.h>
using namespace std;

// The sort order is dependent on the code page.  Use 'chcp' at the
// command line to change the codepage.  When executing this application,
// the command prompt codepage must match the codepage used here:

#define CODEPAGE_850

#ifdef CODEPAGE_850
#define ENGLISH_LOCALE "English_US.850"
#endif

#ifdef CODEPAGE_1252
#define ENGLISH_LOCALE "English_US.1252"
#endif

// The context parameter lets you create a more generic compare.
// Without this parameter, you would have stored the locale in a
// static variable, thus making it vulnerable to thread conflicts
// (if this were a multithreaded program).

int compare( void *pvlocale, char **str1, char **str2)
{
    char *s1 = *str1;
    char *s2 = *str2;

    locale& loc = *( reinterpret_cast< locale * > ( pvlocale));

    return use_facet< collate<char> >(loc).compare(
       s1, s1+strlen(s1),
       s2, s2+strlen(s2) );
}

int main( void )
{
   char *arr[] = {"dog", "pig", "horse", "cat", "human", "rat", "cow", "goat"};

   char *key = "cat";
   char **result;
   int i;

   /* Sort using Quicksort algorithm: */
   qsort_s( arr,
            sizeof(arr)/sizeof(arr[0]),
            sizeof( char * ),
            (int (*)(void*, const void*, const void*))compare,
            &locale(ENGLISH_LOCALE) );

   for( i = 0; i < sizeof(arr)/sizeof(arr[0]); ++i )    /* Output sorted list */
      printf( "%s ", arr[i] );

   /* Find the word "cat" using a binary search algorithm: */
   result = (char **)bsearch_s( &key,
                                arr,
                                sizeof(arr)/sizeof(arr[0]),
                                sizeof( char * ),
                                (int (*)(void*, const void*, const void*))compare,
                                &locale(ENGLISH_LOCALE) );
   if( result )
      printf( "\n%s found at %Fp\n", *result, result );
   else
      printf( "\nCat not found!\n" );
}
cat cow dog goat horse human pig rat
cat found at 002F0F04

関連項目See also

検索と並べ替えSearching and Sorting
_lfind_lfind
_lsearch_lsearch
qsortqsort