home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1998 May / Pcwk5b98.iso / WEBSERVE / PI3 / PI3WEB.EXE / DEVEL / INCLUDE / Pi3Str.h < prev    next >
C/C++ Source or Header  |  1997-10-19  |  5KB  |  165 lines
  1. /*____________________________________________________________________________*\
  2.  *
  3.  
  4.  Copyright (c) 1997 John Roy. All rights reserved.
  5.  
  6.  These sources, libraries and applications are
  7.  FREE FOR COMMERCIAL AND NON-COMMERCIAL USE
  8.  as long as the following conditions are adhered to.
  9.  
  10.  Redistribution and use in source and binary forms, with or without
  11.  modification, are permitted provided that the following conditions
  12.  are met:
  13.  
  14.  1. Redistributions of source code must retain the above copyright
  15.     notice, this list of conditions and the following disclaimer. 
  16.  
  17.  2. Redistributions in binary form must reproduce the above copyright
  18.     notice, this list of conditions and the following disclaimer in
  19.     the documentation and/or other materials provided with the
  20.     distribution.
  21.  
  22.  3. Redistributions of any form whatsoever and all advertising materials 
  23.     mentioning features must contain the following
  24.     acknowledgment:
  25.     "This product includes software developed by John Roy
  26.     (http://www.johnroy.com/pi3/)."
  27.  
  28.  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  29.  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30.  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  31.  IN NO EVENT SHALL THE AUTHORS OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  32.  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33.  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34.  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35.  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36.  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  37.  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  38.  OF THE POSSIBILITY OF SUCH DAMAGE.
  39.  
  40.  *____________________________________________________________________________*|
  41.  *
  42.  * $Source: Pi3Str.h$
  43.  * $Date: Sun Aug 10 06:36:34 1997$
  44.  *
  45.  Description:
  46. \*____________________________________________________________________________*/
  47. /* $HeaderTop:$ */
  48.  
  49. #ifndef PI3STR_H_
  50. #define PI3STR_H_
  51.  
  52. #include "Pi3API.h"
  53.  
  54. /*____________________________________________________________________________*\
  55.  *
  56.  * For binary compatibility, the type Pi3String is opaque outside of the 
  57.     implementation library.
  58. \*____________________________________________________________________________*/
  59. #if defined(PI3_INTERNAL)
  60.  
  61. /* Internal */
  62. typedef struct PIString Pi3String;
  63.  
  64. #else
  65.  
  66. /* External */
  67. typedef int Pi3String;
  68.  
  69. #endif
  70.  
  71. /*____________________________________________________________________________*\
  72.  *
  73.  Name:
  74.     Pi3String_new
  75.  
  76.  Synopsis:
  77.     Pi3String *Pi3String_new( const char *pString );
  78.  
  79.  Description:
  80.     This function is not yet documented.
  81.  
  82.  Notes:
  83.     The parameter pString may be NULL to indicate an empty string.
  84.  
  85.  Return Values:
  86.  Errors:
  87.  See Also:
  88. \*____________________________________________________________________________*/
  89. PUBLIC_PIAPI Pi3String *Pi3String_new( const char *pString );
  90.  
  91. /*____________________________________________________________________________*\
  92.  *
  93.  Name:
  94.     Pi3String_newEx
  95.  
  96.  Synopsis:
  97.     Pi3String *Pi3String_newEx( const char *pString, int iLength );
  98.  
  99.  Description:
  100.     This function is not yet documented.
  101.  
  102.  Notes:
  103.  Return Values:
  104.  Errors:
  105.  See Also:
  106. \*____________________________________________________________________________*/
  107. PUBLIC_PIAPI Pi3String *Pi3String_newEx( const char *pString, int iLength );
  108.  
  109. /*____________________________________________________________________________*\
  110.  *
  111.  Name:
  112.     Pi3String_delete
  113.  
  114.  Synopsis:
  115.     int Pi3String_delete( Pi3String *pString );
  116.  
  117.  Description:
  118.     This function is not yet documented.
  119.  
  120.  Notes:
  121.  Return Values:
  122.  Errors:
  123.  See Also:
  124. \*____________________________________________________________________________*/
  125. PUBLIC_PIAPI int Pi3String_delete( Pi3String *pString );
  126.  
  127. /*____________________________________________________________________________*\
  128.  *
  129.  Name:
  130.     Pi3String_getPtr
  131.  
  132.  Synopsis:
  133.     const char *Pi3String_getPtr( Pi3String *pString );
  134.  
  135.  Description:
  136.     This function is not yet documented.
  137.  
  138.  Notes:
  139.  Return Values:
  140.  Errors:
  141.  See Also:
  142. \*____________________________________________________________________________*/
  143. PUBLIC_PIAPI const char *Pi3String_getPtr( const Pi3String *pString );
  144.  
  145. /*____________________________________________________________________________*\
  146.  *
  147.  Name:
  148.     Pi3String_getLength
  149.  
  150.  Synopsis:
  151.     int Pi3String_getLength( Pi3String *pString );
  152.  
  153.  Description:
  154.     This function is not yet documented.
  155.  
  156.  Notes:
  157.  Return Values:
  158.  Errors:
  159.  See Also:
  160. \*____________________________________________________________________________*/
  161. PUBLIC_PIAPI int Pi3String_getLength( const Pi3String *pString );
  162.  
  163. #endif    /* PI3STR_H_ */
  164.  
  165.