bsearch_s
並べ替えられた配列のバイナリ検索を実行します。この関数は、「CRT のセキュリティ機能」に説明されているように、bsearch のセキュリティが強化されたバージョンです。
void *bsearch_s(
const void *key,
const void *base,
size_t num,
size_t width,
int ( __cdecl *compare ) ( void *, const void *key, const void *datum),
void * context
);
パラメーター
key
検索するオブジェクト。base
検索するデータ配列のベースへのポインター。num
要素の数。width
要素の大きさ。compare
2 つの要素を比較するコールバック関数。最初の引数は context ポインターです。2 番目の引数は、検索用の key へのポインターです。3 番目の引数は、key と比較される配列要素へのポインターです。context
比較関数の中でアクセスされる可能性のあるオブジェクトへのポインター。
戻り値
bsearch_s は、base が指す配列内で key が検出された位置へのポインターを返します。key が見つからない場合は、NULL を返します。配列が昇順に並べ替えられていない場合、または同じキーを持つ重複したレコードがある場合、結果は予測できません。
この関数に無効なパラメーターが渡されると、「パラメーターの検証」に説明されているように、無効なパラメーター ハンドラーが呼び出されます。実行の継続が許可された場合、errno が EINVAL に設定され、関数から NULL が返されます。詳細については、「errno、_doserrno、_sys_errlist、および _sys_nerr」を参照してください。
エラー条件
key |
base |
compare |
num |
width |
errno |
NULL |
任意 |
任意 |
任意 |
任意 |
EINVAL |
任意 |
NULL |
任意 |
!= 0 |
任意 |
EINVAL |
任意 |
任意 |
任意 |
任意 |
= 0 |
EINVAL |
任意 |
任意 |
NULL |
an |
任意 |
EINVAL |
解説
bsearch_s 関数は、並べ替えられた配列のバイナリ サーチを実行します。配列の要素は num 個で、それぞれのサイズは width バイトです。base 値は、検索する配列のベースへのポインターです。key は、検索されている値です。compare パラメーターはユーザーが指定したルーチンへのポインターです。このルーチンは、要求されたキーを配列要素と比較し、その関係を示す次のいずれかの値を返します。
compareルーチンから返される値 |
Description |
|---|---|
< 0 |
キーは配列要素より小さい。 |
0 |
キーは配列要素と等しい。 |
> 0 |
キーは配列要素より大きい。 |
context ポインターは、検索対象のデータ構造体がオブジェクトの一部であり、compare 関数がそのオブジェクトのメンバーにアクセスする必要がある場合に役立ちます。compare 関数は、void ポインターを適切なオブジェクト型にキャストして、そのオブジェクトのメンバーにアクセスできます。context パラメーターの追加により、bsearch_s 関数のセキュリティが強化されます。これは、追加のコンテキストを使用することで、compare 関数に対してデータを利用可能にする静的変数の使用に関連したバグの再入を回避できるためです。
必要条件
ルーチン |
必須ヘッダー |
|---|---|
bsearch_s |
<stdlib.h> および <search.h> |
互換性の詳細については、「C ランタイム ライブラリ」の「互換性」を参照してください。
使用例
次のプログラムでは、qsort_s を使用して文字列配列を並べ替え、bsearch_s を使用して "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" );
}