bin/PSUtil.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PSUtil</name>
    </assembly>
    <members>
        <member name="T:PSUtil.Configuration.HelpOption">
            <summary>
            The ways in which help can be displayed
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HelpOption.Short">
            <summary>
            Only show basic help
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HelpOption.Detailed">
            <summary>
            Show detailed help
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HelpOption.Examples">
            <summary>
            Only show the examples section
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HelpOption.Full">
            <summary>
            Show everything
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HelpOption.Window">
            <summary>
            Show help in a popup window
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HelpOption.Online">
            <summary>
            Show the help website
            </summary>
        </member>
        <member name="T:PSUtil.Configuration.HistoryOption">
            <summary>
            The options on where you search for your history
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HistoryOption.Session">
            <summary>
            Only the history from the current session is shown
            </summary>
        </member>
        <member name="F:PSUtil.Configuration.HistoryOption.Global">
            <summary>
            Uses the PSReadline command history to show all commands ever sent
            </summary>
        </member>
        <member name="T:PSUtil.Object.ObjectConversionMapping">
            <summary>
            Contains all the information needed to convert one object type to another
            </summary>
        </member>
        <member name="F:PSUtil.Object.ObjectConversionMapping.From">
            <summary>
            From what to convert
            </summary>
        </member>
        <member name="F:PSUtil.Object.ObjectConversionMapping.To">
            <summary>
            To what to convert
            </summary>
        </member>
        <member name="F:PSUtil.Object.ObjectConversionMapping.Script">
            <summary>
            The logic that does the converting
            </summary>
        </member>
        <member name="T:PSUtil.Object.ObjectHost">
            <summary>
            Class that hosts static information and helpers for the object type functions
            </summary>
        </member>
        <member name="F:PSUtil.Object.ObjectHost.ExpandedTypes">
            <summary>
            Dictionary of types for which special expansion has been prepared.
            </summary>
        </member>
        <member name="F:PSUtil.Object.ObjectHost.Conversions">
            <summary>
            List of registered conversions
            </summary>
        </member>
        <member name="T:PSUtil.Utility.PsuTimeSpan">
            <summary>
            Wrapper class for a regular timespan. Copied from dbatools
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.Days">
            <summary>
            Gets the days component of the time interval represented by the current TimeSpan structure.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.Hours">
            <summary>
            Gets the hours component of the time interval represented by the current TimeSpan structure.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.Milliseconds">
            <summary>
            Gets the milliseconds component of the time interval represented by the current TimeSpan structure.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.Minutes">
            <summary>
            Gets the minutes component of the time interval represented by the current TimeSpan structure.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.Seconds">
            <summary>
            Gets the seconds component of the time interval represented by the current TimeSpan structure.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.Ticks">
            <summary>
            Gets the number of ticks that represent the value of the current TimeSpan structure.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.TotalDays">
            <summary>
            Gets the value of the current TimeSpan structure expressed in whole and fractional days.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.TotalHours">
            <summary>
            Gets the value of the current TimeSpan structure expressed in whole and fractional hours.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.TotalMilliseconds">
            <summary>
            Gets the value of the current TimeSpan structure expressed in whole and fractional milliseconds.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.TotalMinutes">
            <summary>
            Gets the value of the current TimeSpan structure expressed in whole and fractional minutes.
            </summary>
        </member>
        <member name="P:PSUtil.Utility.PsuTimeSpan.TotalSeconds">
            <summary>
            Gets the value of the current TimeSpan structure expressed in whole and fractional seconds.
            </summary>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.#ctor(System.TimeSpan)">
            <summary>
             
            </summary>
            <param name="Timespan"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.#ctor(System.String)">
            <summary>
            Converts a string into a timespan
            </summary>
            <param name="Timespan">The string to convert</param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.#ctor(System.Int64)">
            <summary>
             
            </summary>
            <param name="ticks"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.#ctor(System.Int32,System.Int32,System.Int32)">
            <summary>
             
            </summary>
            <param name="hours"></param>
            <param name="minutes"></param>
            <param name="seconds"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
            <summary>
             
            </summary>
            <param name="days"></param>
            <param name="hours"></param>
            <param name="minutes"></param>
            <param name="seconds"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
            <summary>
             
            </summary>
            <param name="days"></param>
            <param name="hours"></param>
            <param name="minutes"></param>
            <param name="seconds"></param>
            <param name="milliseconds"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.ParseTimeSpan(System.String)">
            <summary>
            Parses an input string as timespan
            </summary>
            <param name="Value">The string to interpret</param>
            <returns>The interpreted timespan value</returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.Add(System.TimeSpan)">
            <summary>
             
            </summary>
            <param name="ts"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.CompareTo(System.Object)">
            <summary>
             
            </summary>
            <param name="value"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.CompareTo(System.TimeSpan)">
            <summary>
             
            </summary>
            <param name="value"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.CompareTo(PSUtil.Utility.PsuTimeSpan)">
            <summary>
             
            </summary>
            <param name="value"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.Duration">
            <summary>
             
            </summary>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.Equals(System.Object)">
            <summary>
             
            </summary>
            <param name="value"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.Equals(System.TimeSpan)">
            <summary>
             
            </summary>
            <param name="obj"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.GetBaseObject">
            <summary>
            Returns the wrapped base object
            </summary>
            <returns>The base object</returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.GetHashCode">
            <summary>
             
            </summary>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.Negate">
            <summary>
             
            </summary>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.Subtract(System.TimeSpan)">
            <summary>
             
            </summary>
            <param name="ts"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.ToString">
            <summary>
            Returns the default string representation of the TimeSpan object
            </summary>
            <returns>The string representation of the DbaTimeSpan object</returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.ToString(System.String)">
            <summary>
             
            </summary>
            <param name="format"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.ToString(System.String,System.IFormatProvider)">
            <summary>
             
            </summary>
            <param name="format"></param>
            <param name="formatProvider"></param>
            <returns></returns>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.op_Implicit(PSUtil.Utility.PsuTimeSpan)~System.TimeSpan">
            <summary>
            Implicitly converts a DbaTimeSpan object into a TimeSpan object
            </summary>
            <param name="Base">The original object to revert</param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpan.op_Implicit(System.TimeSpan)~PSUtil.Utility.PsuTimeSpan">
            <summary>
            Implicitly converts a TimeSpan object into a DbaTimeSpan object
            </summary>
            <param name="Base">The original object to wrap</param>
        </member>
        <member name="T:PSUtil.Utility.PsuTimeSpanPretty">
            <summary>
            HUmanly friendly representation of a timespan
            </summary>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.FromMilliseconds(System.Double)">
            <summary>
            Creates a new, pretty timespan object from milliseconds
            </summary>
            <param name="Milliseconds">The milliseconds to convert from.</param>
            <returns>A pretty timespan object</returns>
        </member>
        <member name="F:PSUtil.Utility.PsuTimeSpanPretty.Digits">
            <summary>
            The number of digits a pretty timespan should round to.
            </summary>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.#ctor(System.TimeSpan)">
            <summary>
             
            </summary>
            <param name="Timespan"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.#ctor(System.String)">
            <summary>
            Converts a string into a timespan
            </summary>
            <param name="Timespan">The string to convert</param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.#ctor(System.Int64)">
            <summary>
             
            </summary>
            <param name="ticks"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.#ctor(System.Int32,System.Int32,System.Int32)">
            <summary>
             
            </summary>
            <param name="hours"></param>
            <param name="minutes"></param>
            <param name="seconds"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
            <summary>
             
            </summary>
            <param name="days"></param>
            <param name="hours"></param>
            <param name="minutes"></param>
            <param name="seconds"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
            <summary>
             
            </summary>
            <param name="days"></param>
            <param name="hours"></param>
            <param name="minutes"></param>
            <param name="seconds"></param>
            <param name="milliseconds"></param>
        </member>
        <member name="M:PSUtil.Utility.PsuTimeSpanPretty.ToString">
            <summary>
            Creates extra-nice timespan formats
            </summary>
            <returns>Humanly readable timespans</returns>
        </member>
    </members>
</doc>