BARfly Help - BAR Interfacial Function Reference - BAR_Registry Functions

  BAR_Registry::Query_Position

Purpose: To get the zero-based index of an I.F. in the registry.

long Query_Position(BAR_Search_Field Search_Info, BAR_Ident_Type Ident_Type);


Parameters

  • BAR_Search_Field Search_Info:  Information composing the search criteria.
  • BAR_Ident_Type Ident_Type:  The type of data to search for.

Return Values

  • Nonnegative:  Zero-based index of the found I.F.
  • Negative:  Error code.

Remarks

This function returns the zero-based index of the implementation file in the registry whose features meet the search criteria. Search_Info is a platform-dependent identifier that provides the information to search for.  The type and significance of information in Search_Info is determined by the value of Ident_Type.  More about these types can be found here.

Description of how types are searched:

  • BAR_FILEEXTENSIONS: A matching condition qualifies as Search_Info matching any of the extensions in the implementation file’s FILEEXTENSIONS control variable. This is a case-insensitive search.
  • BAR_FILETYPE: A matching condition qualifies as Search_Info matching the implementation file's FILETYPE control variable exactly. This is a case-insensitive search.
  • BAR_FILEDESCRIPTION: A matching condition qualifies as Search_Info matching the implementation file's FILEDESCRIPTION control variable exactly. This is a case-insensitive search.
  • BAR_AUTHOR: A matching condition qualifies as Search_Info matching the implementation file's AUTHOR control variable exactly. This is a case-insensitive search.
  • BAR_SOURCE: A matching condition qualifies as Search_Info matching the implementation file's SOURCE control variable exactly. This is a case-insensitive search.
  • BAR_EXACT_VERSION: A matching condition qualifies as Search_Info matching a value equal to  the implementation file’s VERSION control variable.
  • BAR_MIN_VERSION: A matching condition qualifies as Search_Info matching a value equal to or greater than the implementation file’s VERSION control variable.

Compatibility

  All Platforms Win32 C++ LIB
BAR version 1.1 1.1
  All Platforms Win32
BARfly version 1.0 1.0


  See also:  [BAR_Services Functions] [BAR_Registry Functions] [BAR Functions]


BARfly Help Copyright © 2009 Christopher Allen