PathHelper.xml

<Type Name="PathHelper" FullName="Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
  <TypeSignature Language="C#" Value="public class PathHelper" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PathHelper extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper" />
  <TypeSignature Language="VB.NET" Value="Public Class PathHelper" />
  <TypeSignature Language="F#" Value="type PathHelper = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class PathHelper" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.Configuration.UserSecrets</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>2.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.2.0.0</AssemblyVersion>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>3.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute FrameworkAlternate="net-8.0-pp;net-9.0-pp">
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Provides paths for user secrets configuration files.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PathHelper ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; PathHelper();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Configuration.UserSecrets</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper" />.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetSecretsPathFromSecretsId">
      <MemberSignature Language="C#" Value="public static string GetSecretsPathFromSecretsId (string userSecretsId);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig string GetSecretsPathFromSecretsId(string userSecretsId) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function GetSecretsPathFromSecretsId (userSecretsId As String) As String" />
      <MemberSignature Language="F#" Value="static member GetSecretsPathFromSecretsId : string -&gt; string" Usage="Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId userSecretsId" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static System::String ^ GetSecretsPathFromSecretsId(System::String ^ userSecretsId);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Configuration.UserSecrets</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="userSecretsId" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="userSecretsId">The user secret ID.</param>
        <summary>
          <para>
            Returns the path to the JSON file that stores user secrets.
            </para>
          <para>
            This uses the current user profile to locate the secrets file on disk in a location outside of source control.
            </para>
        </summary>
        <returns>The full path to the secret file.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>