Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DtSearchGetKeytypes(library call)	     DtSearchGetKeytypes(library call)

NAME
       DtSearchGetKeytypes  --	Access the Keytypes array for a	DtSearch data-
       base

SYNOPSIS
       #include	<Dt/Search.h>
       int DtSearchGetKeytypes(
       char *dbname,
       int *ktcount,
       DtSrKeytype **keytypes);

DESCRIPTION
       The DtSearchGetKeytypes function	returns	a pointer to the keytypes  ar-
       ray  of	the  specified database. The caller may	modify the is_selected
       member of any DtSrKeytype but should not	alter any other	member values.

       This function may be called anytime after DtSearchInit.

ARGUMENTS
       dbname	 Specifies for which database the keytypes are	requested.  It
		 is  any  one  of the database name strings from the array re-
		 turned	from DtSearchInit  or  DtSearchReinit.	If  dbname  is
		 NULL, the first database name string in the array is used.

       ktcount	 Specifies the address of the integer where the	keytypes array
		 size will be stored.

       keytypes	 Specifies the address where pointer to	keytypes array will be
		 stored.

RETURN VALUE
       Returns DtSrOK and keytypes pointer and size.

       Any API function	can also return	DtSrREINIT or the return codes for fa-
       tal engine errors, as well as messages on the MessageList, at any time.

SEE ALSO
       dtsrcreate(1), DtSearchQuery(3),	DtSrAPI(3), DtSearch(5)

					     DtSearchGetKeytypes(library call)

NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=DtSearchGetKeytypes&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help