Dependencies/Assemblies/Microsoft365DSC.Utilities.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft365DSC.Utilities</name> </assembly> <members> <member name="T:Microsoft365DSC.Utilities.DriftRecord"> <summary> Builds the drift entries every comparer reports: PropertyName, CurrentValue, DesiredValue and, for collection drifts, DeltaValue. </summary> </member> <member name="T:Microsoft365DSC.Utilities.MemberAccessor"> <summary> Reads named members off the loosely-typed values that flow between PowerShell and C#. A single property can arrive as a <see cref="T:System.Collections.Hashtable"/>, a <see cref="T:System.Management.Automation.PSObject"/> wrapping a PSCustomObject, a CimInstance, or a plain CLR object. Rather than branching on each of those at every call site, everything funnels through here. CimInstance is handled without referencing Microsoft.Management.Infrastructure, because PowerShell's own object adapter surfaces its properties through PSObject. </summary> </member> <member name="M:Microsoft365DSC.Utilities.MemberAccessor.Unwrap(System.Object)"> <summary> Unwraps a <see cref="T:System.Management.Automation.PSObject"/> to the object it wraps, leaving anything else alone. </summary> <param name="value">The value to unwrap.</param> <returns>The underlying object, or the original value when it is not a PSObject.</returns> <remarks> A PSCustomObject is deliberately not unwrapped. Its properties live on the PSObject wrapper rather than on the base object, so unwrapping one would discard everything it carries and make every member lookup fail. </remarks> </member> <member name="M:Microsoft365DSC.Utilities.MemberAccessor.TryGetMember(System.Object,System.String,System.Object@)"> <summary> Attempts to read a named member from a value. </summary> <param name="source">The object to read from. May be null.</param> <param name="name">The member name. Matching is case-insensitive.</param> <param name="value">Receives the member value, already unwrapped.</param> <returns> True when the member exists. A member that exists but is null still returns true, so callers can tell "absent" apart from "present but empty". </returns> </member> <member name="M:Microsoft365DSC.Utilities.MemberAccessor.TryGetDictionaryEntry(System.Collections.IDictionary,System.String,System.Object@)"> <summary> Looks a key up in a dictionary, preferring the dictionary's own comparer and falling back to a case-insensitive scan for dictionaries that are ordinal. </summary> <param name="dictionary">The dictionary to search.</param> <param name="name">The key to find.</param> <param name="value">Receives the entry value, already unwrapped.</param> <returns>True when the key exists.</returns> </member> <member name="M:Microsoft365DSC.Utilities.MemberAccessor.GetMemberAsString(System.Object,System.String)"> <summary> Reads a member and renders it as a string, returning null when the member is absent, null, or renders empty. </summary> <param name="source">The object to read from.</param> <param name="name">The member name.</param> <returns>The member value as a string, or null.</returns> </member> <member name="P:Microsoft365DSC.Utilities.Utilities.AuthenticationPropertyNames"> <summary> The property names every resource carries for authentication. Callers build their own set from these so each keeps its own string comparer. </summary> </member> <member name="F:Microsoft365DSC.Utilities.Utilities.UnsupportedInstanceNameCharacters"> <summary> The characters that cannot appear in a DSC instance name without escaping. The smart quotes are listed by code point because this file is written in ASCII. </summary> </member> <member name="M:Microsoft365DSC.Utilities.Utilities.RemoveSpecialCharacters(System.String)"> <summary> Replaces every character that would need escaping inside a DSC instance name with an underscore. </summary> <param name="input">The value to turn into an instance name segment.</param> <returns>A value that renders the same wherever it is written.</returns> </member> <member name="M:Microsoft365DSC.Utilities.Utilities.UpdateSpecialCharacters(System.String)"> <summary> Method to update special characters in strings. This method handles the conversion of special characters similar to Update-M365DSCSpecialCharacters. This function updates special characters in a string to be escaped in a DSC configuration. The function replaces the following characters: - 0x201C = “ - 0x201D = ” - 0x201E = „ </summary> <param name="input">The input string to process</param> <returns>The processed string with special characters updated</returns> </member> </members> </doc> |