API/JSStringRefBSTR.h

   1 /*
   2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #ifndef JSStringRefBSTR_h
  30 #define JSStringRefBSTR_h
  31
  32 #include "JSBase.h"
  33
  34 #include <windows.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /* COM convenience methods */
  41
  42 /*!
  43 @function
  44 @abstract         Creates a JavaScript string from a BSTR.
  45 @param string     The BSTR to copy into the new JSString.
  46 @result           A JSString containing string. Ownership follows the Create Rule.
  47 */
  48 JS_EXPORT JSStringRef JSStringCreateWithBSTR(const BSTR string);
  49
  50 /*!
  51 @function
  52 @abstract         Creates a BSTR from a JavaScript string.
  53 @param string     The JSString to copy into the new BSTR.
  54 @result           A BSTR containing string. Ownership follows the Create Rule.
  55 */
  56 JS_EXPORT BSTR JSStringCopyBSTR(const JSStringRef string);
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif
  61
  62 #endif /* JSStringRefBSTR_h */