BaseVsaSite.xml

<Type Name="BaseVsaSite" FullName="Microsoft.JScript.Vsa.BaseVsaSite">
  <TypeSignature Language="C#" Value="public class BaseVsaSite : Microsoft.JScript.Vsa.IJSVsaSite" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BaseVsaSite extends System.Object implements class Microsoft.JScript.Vsa.IJSVsaSite" />
  <TypeSignature Language="DocId" Value="T:Microsoft.JScript.Vsa.BaseVsaSite" />
  <TypeSignature Language="VB.NET" Value="Public Class BaseVsaSite&#xA;Implements IJSVsaSite" />
  <TypeSignature Language="F#" Value="type BaseVsaSite = class&#xA;    interface IJSVsaSite" />
  <TypeSignature Language="C++ CLI" Value="public ref class BaseVsaSite : Microsoft::JScript::Vsa::IJSVsaSite" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.JScript</AssemblyName>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>Microsoft.JScript.Vsa.IJSVsaSite</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Obsolete("Use of this type is not recommended because it is being deprecated in Visual Studio 2005; there will be no replacement for this feature. Please see the ICodeCompiler documentation for additional help.")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Obsolete("Use of this type is not recommended because it is being deprecated in Visual Studio 2005; there will be no replacement for this feature. Please see the ICodeCompiler documentation for additional help.")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Enables communication between the host and the script engine.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public BaseVsaSite ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.Vsa.BaseVsaSite.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; BaseVsaSite();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>Creates a new site.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Assembly">
      <MemberSignature Language="C#" Value="public virtual byte[] Assembly { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] Assembly" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.Vsa.BaseVsaSite.Assembly" />
      <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Assembly As Byte()" />
      <MemberSignature Language="F#" Value="member this.Assembly : byte[]" Usage="Microsoft.JScript.Vsa.BaseVsaSite.Assembly" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property cli::array &lt;System::Byte&gt; ^ Assembly { cli::array &lt;System::Byte&gt; ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Byte[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>An assembly for this site.</summary>
        <value>An assembly for this site.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DebugInfo">
      <MemberSignature Language="C#" Value="public virtual byte[] DebugInfo { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] DebugInfo" />
      <MemberSignature Language="DocId" Value="P:Microsoft.JScript.Vsa.BaseVsaSite.DebugInfo" />
      <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property DebugInfo As Byte()" />
      <MemberSignature Language="F#" Value="member this.DebugInfo : byte[]" Usage="Microsoft.JScript.Vsa.BaseVsaSite.DebugInfo" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual property cli::array &lt;System::Byte&gt; ^ DebugInfo { cli::array &lt;System::Byte&gt; ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Byte[]</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Debug information for this site.</summary>
        <value>Debug information for this site.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetCompiledState">
      <MemberSignature Language="C#" Value="public virtual void GetCompiledState (out byte[] pe, out byte[] debugInfo);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void GetCompiledState([out] unsigned int8[]&amp; pe, [out] unsigned int8[]&amp; debugInfo) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.Vsa.BaseVsaSite.GetCompiledState(System.Byte[]@,System.Byte[]@)" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub GetCompiledState (ByRef pe As Byte(), ByRef debugInfo As Byte())" />
      <MemberSignature Language="F#" Value="abstract member GetCompiledState : Byte[] * Byte[] -&gt; unit&#xA;override this.GetCompiledState : Byte[] * Byte[] -&gt; unit" Usage="baseVsaSite.GetCompiledState (pe, debugInfo)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void GetCompiledState([Runtime::InteropServices::Out] cli::array &lt;System::Byte&gt; ^ % pe, [Runtime::InteropServices::Out] cli::array &lt;System::Byte&gt; ^ % debugInfo);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.JScript.Vsa.IJSVsaSite.GetCompiledState(System.Byte[]@,System.Byte[]@)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="pe" Type="System.Byte[]" RefType="out" />
        <Parameter Name="debugInfo" Type="System.Byte[]" RefType="out" />
      </Parameters>
      <Docs>
        <param name="pe">An assembly to be set.</param>
        <param name="debugInfo">Debug info object to be set.</param>
        <summary>Sets an assembly and debug info for this site.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetEventSourceInstance">
      <MemberSignature Language="C#" Value="public virtual object GetEventSourceInstance (string itemName, string eventSourceName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object GetEventSourceInstance(string itemName, string eventSourceName) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.Vsa.BaseVsaSite.GetEventSourceInstance(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Function GetEventSourceInstance (itemName As String, eventSourceName As String) As Object" />
      <MemberSignature Language="F#" Value="abstract member GetEventSourceInstance : string * string -&gt; obj&#xA;override this.GetEventSourceInstance : string * string -&gt; obj" Usage="baseVsaSite.GetEventSourceInstance (itemName, eventSourceName)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual System::Object ^ GetEventSourceInstance(System::String ^ itemName, System::String ^ eventSourceName);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.JScript.Vsa.IJSVsaSite.GetEventSourceInstance(System.String,System.String)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="itemName" Type="System.String" />
        <Parameter Name="eventSourceName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="itemName">The specified item name.</param>
        <param name="eventSourceName">The specified event source name.</param>
        <summary>Gets a reference to an event source previously added to a script engine using the <see cref="M:Microsoft.JScript.Vsa.IJSVsaCodeItem.AddEventSource(System.String,System.String)" /> method.</summary>
        <returns>The event source to the engine.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetGlobalInstance">
      <MemberSignature Language="C#" Value="public virtual object GetGlobalInstance (string name);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object GetGlobalInstance(string name) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.Vsa.BaseVsaSite.GetGlobalInstance(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Function GetGlobalInstance (name As String) As Object" />
      <MemberSignature Language="F#" Value="abstract member GetGlobalInstance : string -&gt; obj&#xA;override this.GetGlobalInstance : string -&gt; obj" Usage="baseVsaSite.GetGlobalInstance name" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual System::Object ^ GetGlobalInstance(System::String ^ name);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.JScript.Vsa.IJSVsaSite.GetGlobalInstance(System.String)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="name">Gets a reference to a global item, such as the host-provided application object.</param>
        <summary>Gets a reference to a global item, such as the host-provided application object.</summary>
        <returns>A reference to the global object.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Notify">
      <MemberSignature Language="C#" Value="public virtual void Notify (string notify, object optional);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Notify(string notify, object optional) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.Vsa.BaseVsaSite.Notify(System.String,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Sub Notify (notify As String, optional As Object)" />
      <MemberSignature Language="F#" Value="abstract member Notify : string * obj -&gt; unit&#xA;override this.Notify : string * obj -&gt; unit" Usage="baseVsaSite.Notify (notify, optional)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void Notify(System::String ^ notify, System::Object ^ optional);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.JScript.Vsa.IJSVsaSite.Notify(System.String,System.Object)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="notify" Type="System.String" />
        <Parameter Name="optional" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="notify">Notifies the host about events generated by the script engine.</param>
        <param name="optional">Notifies the host about events generated by the engine.</param>
        <summary>Notifies the host about events generated by the script engine.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnCompilerError">
      <MemberSignature Language="C#" Value="public virtual bool OnCompilerError (Microsoft.JScript.Vsa.IJSVsaError error);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool OnCompilerError(class Microsoft.JScript.Vsa.IJSVsaError error) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.JScript.Vsa.BaseVsaSite.OnCompilerError(Microsoft.JScript.Vsa.IJSVsaError)" />
      <MemberSignature Language="VB.NET" Value="Public Overridable Function OnCompilerError (error As IJSVsaError) As Boolean" />
      <MemberSignature Language="F#" Value="abstract member OnCompilerError : Microsoft.JScript.Vsa.IJSVsaError -&gt; bool&#xA;override this.OnCompilerError : Microsoft.JScript.Vsa.IJSVsaError -&gt; bool" Usage="baseVsaSite.OnCompilerError error" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual bool OnCompilerError(Microsoft::JScript::Vsa::IJSVsaError ^ error);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.JScript.Vsa.IJSVsaSite.OnCompilerError(Microsoft.JScript.Vsa.IJSVsaError)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.JScript</AssemblyName>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="error" Type="Microsoft.JScript.Vsa.IJSVsaError" />
      </Parameters>
      <Docs>
        <param name="error">The <see cref="T:Microsoft.JScript.Vsa.IJSVsaError" /> object representing the offending error.</param>
        <summary>Notifies the host about how to respond to compiler errors encountered by the script engine.</summary>
        <returns>
          <see langword="true" /> if the compiler is directed to continue reporting further errors to the <see cref="T:Microsoft.JScript.Vsa.IJSVsaSite" /> object; <see langword="false" /> if the compiler is directed to stop reporting further errors to the <see langword="IVsaSite" /> object.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>