File size: 3,758 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation
{
/// <summary>
/// The ProviderCommandHelpInfo class.
/// </summary>
internal class ProviderCommandHelpInfo : HelpInfo
{
/// <summary>
/// Help info.
/// </summary>
private readonly HelpInfo _helpInfo;
/// <summary>
/// Constructor for ProviderCommandHelpInfo.
/// </summary>
internal ProviderCommandHelpInfo(HelpInfo genericHelpInfo, ProviderContext providerContext)
{
Dbg.Assert(genericHelpInfo != null, "Expected genericHelpInfo != null");
Dbg.Assert(providerContext != null, "Expected providerContext != null");
// This should be set to None to prevent infinite forwarding.
this.ForwardHelpCategory = HelpCategory.None;
// Now pick which help we should show.
MamlCommandHelpInfo providerSpecificHelpInfo =
providerContext.GetProviderSpecificHelpInfo(genericHelpInfo.Name);
if (providerSpecificHelpInfo == null)
{
_helpInfo = genericHelpInfo;
}
else
{
providerSpecificHelpInfo.OverrideProviderSpecificHelpWithGenericHelp(genericHelpInfo);
_helpInfo = providerSpecificHelpInfo;
}
}
/// <summary>
/// Get parameter.
/// </summary>
internal override PSObject[] GetParameter(string pattern)
{
return _helpInfo.GetParameter(pattern);
}
/// <summary>
/// Returns the Uri used by get-help cmdlet to show help
/// online. Returns only the first uri found under
/// RelatedLinks.
/// </summary>
/// <returns>
/// Null if no Uri is specified by the helpinfo or a
/// valid Uri.
/// </returns>
internal override Uri GetUriForOnlineHelp()
{
return _helpInfo.GetUriForOnlineHelp();
}
/// <summary>
/// The Name property.
/// </summary>
internal override string Name
{
get
{
return _helpInfo.Name;
}
}
/// <summary>
/// The Synopsis property.
/// </summary>
internal override string Synopsis
{
get
{
return _helpInfo.Synopsis;
}
}
/// <summary>
/// The HelpCategory property.
/// </summary>
internal override HelpCategory HelpCategory
{
get
{
return _helpInfo.HelpCategory;
}
}
/// <summary>
/// The FullHelp property.
/// </summary>
internal override PSObject FullHelp
{
get
{
return _helpInfo.FullHelp;
}
}
/// <summary>
/// The Component property.
/// </summary>
internal override string Component
{
get
{
return _helpInfo.Component;
}
}
/// <summary>
/// The Role property.
/// </summary>
internal override string Role
{
get
{
return _helpInfo.Role;
}
}
/// <summary>
/// The Functionality property.
/// </summary>
internal override string Functionality
{
get
{
return _helpInfo.Functionality;
}
}
}
}
|