src/Standard/Standard_ExtString.hxx

   1 // Copyright (c) 1998-1999 Matra Datavision
   2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   3 //
   4 // This file is part of Open CASCADE Technology software library.
   5 //
   6 // This library is free software; you can redistribute it and/or modify it under
   7 // the terms of the GNU Lesser General Public License version 2.1 as published
   8 // by the Free Software Foundation, with special exception defined in the file
   9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 // distribution for complete text of the license and disclaimer of any warranty.
  11 //
  12 // Alternatively, this file may be used under the terms of Open CASCADE
  13 // commercial license or contractual agreement.
  14
  15 //============================================================================
  16 //==== Titre: Standard_ExtString.hxx
  17 //====
  18 //==== Implementation:  This is a primitive type implementadef with typedef
  19 //====        typedef short* Standard_ExtString;
  20 //============================================================================
  21
  22 #ifndef _Standard_ExtString_HeaderFile
  23 #define _Standard_ExtString_HeaderFile
  24
  25 #include <Standard_TypeDef.hxx>
  26
  27 //! Computes a hash code for the given wide character string, in the range [1, theUpperBound]
  28 //! @param theExtString the wide character string which hash code is to be computed
  29 //! @param theUpperBound the upper bound of the range a computing hash code must be within
  30 //! @return a computed hash code, in the range [1, theUpperBound]
  31 Standard_EXPORT Standard_Integer HashCode (Standard_ExtString theExtString, Standard_Integer theUpperBound);
  32
  33 #endif