SecurityCallContext.xml

<Type Name="SecurityCallContext" FullName="System.EnterpriseServices.SecurityCallContext">
  <TypeSignature Language="C#" Value="public sealed class SecurityCallContext" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SecurityCallContext extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.EnterpriseServices.SecurityCallContext" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class SecurityCallContext" />
  <TypeSignature Language="F#" Value="type SecurityCallContext = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class SecurityCallContext sealed" />
  <AssemblyInfo>
    <AssemblyName>System.EnterpriseServices</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Describes the chain of callers leading up to the current method call.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following code example demonstrates the use of the <xref:System.EnterpriseServices.SecurityCallContext> class to interrogate the security context of calls to the methods of a <xref:System.EnterpriseServices.ServicedComponent> class.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Security/CPP/employeeinformation.cpp" id="Snippet4":::
 :::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/AccessChecksLevelOption/Overview/employeeinformation.cs" id="Snippet4":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Security/VB/employeeinformation.vb" id="Snippet4":::  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Callers">
      <MemberSignature Language="C#" Value="public System.EnterpriseServices.SecurityCallers Callers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.EnterpriseServices.SecurityCallers Callers" />
      <MemberSignature Language="DocId" Value="P:System.EnterpriseServices.SecurityCallContext.Callers" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Callers As SecurityCallers" />
      <MemberSignature Language="F#" Value="member this.Callers : System.EnterpriseServices.SecurityCallers" Usage="System.EnterpriseServices.SecurityCallContext.Callers" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::EnterpriseServices::SecurityCallers ^ Callers { System::EnterpriseServices::SecurityCallers ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.EnterpriseServices.SecurityCallers</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:System.EnterpriseServices.SecurityCallers" /> object that describes the caller.</summary>
        <value>The <see cref="T:System.EnterpriseServices.SecurityCallers" /> object that describes the caller.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 <xref:System.EnterpriseServices.SecurityCallContext.Callers%2A> accesses the `Callers` item in the `ISecurityCallContext` collection in COM+.  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.Runtime.InteropServices.COMException">There is no security context.</exception>
      </Docs>
    </Member>
    <Member MemberName="CurrentCall">
      <MemberSignature Language="C#" Value="public static System.EnterpriseServices.SecurityCallContext CurrentCall { get; }" />
      <MemberSignature Language="ILAsm" Value=".property class System.EnterpriseServices.SecurityCallContext CurrentCall" />
      <MemberSignature Language="DocId" Value="P:System.EnterpriseServices.SecurityCallContext.CurrentCall" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property CurrentCall As SecurityCallContext" />
      <MemberSignature Language="F#" Value="static member CurrentCall : System.EnterpriseServices.SecurityCallContext" Usage="System.EnterpriseServices.SecurityCallContext.CurrentCall" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::EnterpriseServices::SecurityCallContext ^ CurrentCall { System::EnterpriseServices::SecurityCallContext ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.EnterpriseServices.SecurityCallContext</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:System.EnterpriseServices.SecurityCallContext" /> object that describes the security call context.</summary>
        <value>The <see cref="T:System.EnterpriseServices.SecurityCallContext" /> object that describes the security call context.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The static <xref:System.EnterpriseServices.SecurityCallContext.CurrentCall%2A> property is the recommended way to access the security call context.  
  
   
  
## Examples  
 The following code example demonstrates the use of this method to obtain a <xref:System.EnterpriseServices.SecurityCallContext> object describing the security context of a method call.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Security/CPP/employeeinformation.cpp" id="Snippet6":::
 :::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/AccessChecksLevelOption/Overview/employeeinformation.cs" id="Snippet6":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Security/VB/employeeinformation.vb" id="Snippet6":::  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="DirectCaller">
      <MemberSignature Language="C#" Value="public System.EnterpriseServices.SecurityIdentity DirectCaller { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.EnterpriseServices.SecurityIdentity DirectCaller" />
      <MemberSignature Language="DocId" Value="P:System.EnterpriseServices.SecurityCallContext.DirectCaller" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property DirectCaller As SecurityIdentity" />
      <MemberSignature Language="F#" Value="member this.DirectCaller : System.EnterpriseServices.SecurityIdentity" Usage="System.EnterpriseServices.SecurityCallContext.DirectCaller" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::EnterpriseServices::SecurityIdentity ^ DirectCaller { System::EnterpriseServices::SecurityIdentity ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.EnterpriseServices.SecurityIdentity</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:System.EnterpriseServices.SecurityIdentity" /> object that describes the direct caller of this method.</summary>
        <value>A <see cref="T:System.EnterpriseServices.SecurityIdentity" /> value.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following code example demonstrates the use of this method to check the identity of the direct caller of a <xref:System.EnterpriseServices.ServicedComponent> method.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Security/CPP/employeeinformation.cpp" id="Snippet7":::
 :::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/AccessChecksLevelOption/Overview/employeeinformation.cs" id="Snippet7":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Security/VB/employeeinformation.vb" id="Snippet7":::  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="IsCallerInRole">
      <MemberSignature Language="C#" Value="public bool IsCallerInRole (string role);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsCallerInRole(string role) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.EnterpriseServices.SecurityCallContext.IsCallerInRole(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function IsCallerInRole (role As String) As Boolean" />
      <MemberSignature Language="F#" Value="member this.IsCallerInRole : string -&gt; bool" Usage="securityCallContext.IsCallerInRole role" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; bool IsCallerInRole(System::String ^ role);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="role" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="role">The specified role.</param>
        <summary>Verifies that the direct caller is a member of the specified role.</summary>
        <returns>
          <see langword="true" /> if the direct caller is a member of the specified role; otherwise, <see langword="false" />.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following code example demonstrates the use of this method to determine if the caller of a <xref:System.EnterpriseServices.ServicedComponent> method is in a specified role.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/EnterpriseServices_Security/CPP/employeeinformation.cpp" id="Snippet6":::
 :::code language="csharp" source="~/snippets/csharp/System.EnterpriseServices/AccessChecksLevelOption/Overview/employeeinformation.cs" id="Snippet6":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/EnterpriseServices_Security/VB/employeeinformation.vb" id="Snippet6":::  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="IsSecurityEnabled">
      <MemberSignature Language="C#" Value="public bool IsSecurityEnabled { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool IsSecurityEnabled" />
      <MemberSignature Language="DocId" Value="P:System.EnterpriseServices.SecurityCallContext.IsSecurityEnabled" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsSecurityEnabled As Boolean" />
      <MemberSignature Language="F#" Value="member this.IsSecurityEnabled : bool" Usage="System.EnterpriseServices.SecurityCallContext.IsSecurityEnabled" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool IsSecurityEnabled { bool get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Determines whether security checks are enabled in the current context.</summary>
        <value>
          <see langword="true" /> if security checks are enabled in the current context; otherwise, <see langword="false" />.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsUserInRole">
      <MemberSignature Language="C#" Value="public bool IsUserInRole (string user, string role);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsUserInRole(string user, string role) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.EnterpriseServices.SecurityCallContext.IsUserInRole(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function IsUserInRole (user As String, role As String) As Boolean" />
      <MemberSignature Language="F#" Value="member this.IsUserInRole : string * string -&gt; bool" Usage="securityCallContext.IsUserInRole (user, role)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; bool IsUserInRole(System::String ^ user, System::String ^ role);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="user" Type="System.String" />
        <Parameter Name="role" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="user">The specified user.</param>
        <param name="role">The specified role.</param>
        <summary>Verifies that the specified user is in the specified role.</summary>
        <returns>
          <see langword="true" /> if the specified user is a member of the specified role; otherwise, <see langword="false" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MinAuthenticationLevel">
      <MemberSignature Language="C#" Value="public int MinAuthenticationLevel { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 MinAuthenticationLevel" />
      <MemberSignature Language="DocId" Value="P:System.EnterpriseServices.SecurityCallContext.MinAuthenticationLevel" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property MinAuthenticationLevel As Integer" />
      <MemberSignature Language="F#" Value="member this.MinAuthenticationLevel : int" Usage="System.EnterpriseServices.SecurityCallContext.MinAuthenticationLevel" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int MinAuthenticationLevel { int get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the <see langword="MinAuthenticationLevel" /> value from the <see langword="ISecurityCallContext" /> collection in COM+.</summary>
        <value>The <see langword="MinAuthenticationLevel" /> value from the <see langword="ISecurityCallContext" /> collection in COM+.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 <xref:System.EnterpriseServices.SecurityCallContext.MinAuthenticationLevel%2A> is the least secure authentication level of all callers in the chain.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="NumCallers">
      <MemberSignature Language="C#" Value="public int NumCallers { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 NumCallers" />
      <MemberSignature Language="DocId" Value="P:System.EnterpriseServices.SecurityCallContext.NumCallers" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property NumCallers As Integer" />
      <MemberSignature Language="F#" Value="member this.NumCallers : int" Usage="System.EnterpriseServices.SecurityCallContext.NumCallers" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int NumCallers { int get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the <see langword="NumCallers" /> value from the <see langword="ISecurityCallContext" /> collection in COM+.</summary>
        <value>The <see langword="NumCallers" /> value from the <see langword="ISecurityCallContext" /> collection in COM+.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 <xref:System.EnterpriseServices.SecurityCallContext.NumCallers%2A> is the number of callers in the chain of calls.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="OriginalCaller">
      <MemberSignature Language="C#" Value="public System.EnterpriseServices.SecurityIdentity OriginalCaller { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.EnterpriseServices.SecurityIdentity OriginalCaller" />
      <MemberSignature Language="DocId" Value="P:System.EnterpriseServices.SecurityCallContext.OriginalCaller" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property OriginalCaller As SecurityIdentity" />
      <MemberSignature Language="F#" Value="member this.OriginalCaller : System.EnterpriseServices.SecurityIdentity" Usage="System.EnterpriseServices.SecurityCallContext.OriginalCaller" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::EnterpriseServices::SecurityIdentity ^ OriginalCaller { System::EnterpriseServices::SecurityIdentity ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.EnterpriseServices</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.EnterpriseServices.SecurityIdentity</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:System.EnterpriseServices.SecurityIdentity" /> that describes the original caller.</summary>
        <value>One of the <see cref="T:System.EnterpriseServices.SecurityIdentity" /> values.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>