bsearch_s

Статья
06/09/2015

Выполняет бинарный поиск в сортированном массиве. Эта версия bsearch с усовершенствованной безопасностью, как описано в разделе Функции безопасности в CRT.

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
Функция обратного вызова, которая сравнивает два элемента. Первый аргумент — это указатель context. Второй аргумент — указатель на key для поиска. Третий аргумент — указатель на элемент массива, который будет сравниваться с key.
context
Указатель на объект, доступ к которому можно получить в функции сравнения.

Возвращаемое значение

bsearch_s возвращает указатель на вхождение key в массив, указанный в base. Если key не найден, функция возвращает NULL. Если массив не отсортирован по возрастанию или содержит повторяющиеся записи с одинаковыми ключами, невозможно точно предсказать результат.

Если функции переданы недопустимые параметры, вызывается обработчик недопустимых параметров, как описано в разделе Проверка параметров. Если продолжение выполнения разрешено, то errnoустанавливается в EINVAL, и функция возвращает NULL. Дополнительные сведения см. в разделе errno, _doserrno, _sys_errlist, and _sys_nerr.

Условия возникновения ошибки

key	base	compare	num	width	errno
NULL	any	any	any	any	EINVAL
any	NULL	any	!= 0	any	EINVAL
any	any	any	any	= 0	EINVAL
any	any	NULL	any	any	EINVAL

Заметки

Функция bsearch_s выполняет бинарный поиск по отсортированному массиву, состоящему из num элементов, каждый размером width байт. Значение base — указатель на начало массива, в котором должен производиться поиск, а key — искомое значение. Параметр compare — указатель предоставляемую пользователем процедуру, которая сравнивает требуемый ключ с элементом массива и возвращает одно из следующих значений, отражающих их связь:

Значение, возвращаемое процедурой compare	Описание
< 0	Ключ меньше, чем элемент массива.
0	Ключ равен элементу массива.
> 0	Ключ больше, чем элемент массива.

Указатель context может быть полезен, если искомая структура данных является частью объекта и функции сравнения требуется доступ к членам объекта. Функция compare может привести указатель на void к соответствующему типу объекта и получить доступ к членам этого объекта. Добавление параметра context делает bsearch_s более безопасной, поскольку наличие дополнительного контекста может использоваться для предотвращения ошибок повторного входа, связанных с использованием статических переменных, чтобы сделать данные доступными для функции compare.

Требования

Подпрограмма	Обязательный заголовок
bsearch_s	<stdlib.h> и <search.h>

Дополнительные сведения о совместимости см. в разделе Совместимость во введении.

Пример

Программа сортирует массива строк с помощью qsort_s, а затем использует bsearch_s, чтобы обнаружить ключевое слово «кот».

// 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" );
}