Skip to content

Commit

Permalink
Update comments in AddPackage (#103)
Browse files Browse the repository at this point in the history
Removed the reference to specify a folder containing multiple cab files from the description of the packagePath parameter, since that scenario is not supported by the underlying API.
  • Loading branch information
yudomsft authored Sep 15, 2020
1 parent 18f097a commit 5d12437
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/Microsoft.Dism/DismApi.AddPackage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public static partial class DismApi
/// Adds a single .cab or .msu file to a Windows® image.
/// </summary>
/// <param name="session">A valid DISM Session. The DISM Session must be associated with an image. You can associate a session with an image by using the OpenSession method.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added, a folder with one or more packages, or a folder containing the expanded files of a single .cab file.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added or a folder containing the expanded files of a single .cab file.</param>
/// <param name="ignoreCheck">Specifies whether to ignore the internal applicability checks that are done when a package is added.</param>
/// <param name="preventPending">Specifies whether to add a package if it has pending online actions.</param>
/// <exception cref="DismException">When a failure occurs.</exception>
Expand All @@ -29,7 +29,7 @@ public static void AddPackage(DismSession session, string packagePath, bool igno
/// Adds a single .cab or .msu file to a Windows® image.
/// </summary>
/// <param name="session">A valid DISM Session. The DISM Session must be associated with an image. You can associate a session with an image by using the OpenSession method.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added, a folder with one or more packages, or a folder containing the expanded files of a single .cab file.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added or a folder containing the expanded files of a single .cab file.</param>
/// <param name="ignoreCheck">Specifies whether to ignore the internal applicability checks that are done when a package is added.</param>
/// <param name="preventPending">Specifies whether to add a package if it has pending online actions.</param>
/// <param name="progressCallback">A DismProgressCallback method to call when progress is made.</param>
Expand All @@ -46,7 +46,7 @@ public static void AddPackage(DismSession session, string packagePath, bool igno
/// Adds a single .cab or .msu file to a Windows® image.
/// </summary>
/// <param name="session">A valid DISM Session. The DISM Session must be associated with an image. You can associate a session with an image by using the OpenSession method.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added, a folder with one or more packages, or a folder containing the expanded files of a single .cab file.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added or a folder containing the expanded files of a single .cab file.</param>
/// <param name="ignoreCheck">Specifies whether to ignore the internal applicability checks that are done when a package is added.</param>
/// <param name="preventPending">Specifies whether to add a package if it has pending online actions.</param>
/// <param name="progressCallback">A DismProgressCallback method to call when progress is made.</param>
Expand All @@ -71,7 +71,7 @@ internal static partial class NativeMethods
/// Adds a single .cab or .msu file to a Windows® image.
/// </summary>
/// <param name="session">A valid DISM Session. The DISM Session must be associated with an image. You can associate a session with an image by using the DismOpenSession Function.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added, a folder with one or more packages, or a folder containing the expanded files of a single .cab file.</param>
/// <param name="packagePath">A relative or absolute path to the .cab or .msu file being added or a folder containing the expanded files of a single .cab file.</param>
/// <param name="ignoreCheck">A Boolean value to specify whether to ignore the internal applicability checks that are done when a package is added.</param>
/// <param name="preventPending">A Boolean value to specify whether to add a package if it has pending online actions.</param>
/// <param name="cancelEvent">Optional. You can set a CancelEvent for this function in order to cancel the operation in progress when signaled by the client. If the CancelEvent is received at a stage when the operation cannot be canceled, the operation will continue and return a success code. If the CancelEvent is received and the operation is canceled, the image state is unknown. You should verify the image state before continuing or discard the changes and start again.</param>
Expand All @@ -89,4 +89,4 @@ internal static partial class NativeMethods
public static extern int DismAddPackage(DismSession session, string packagePath, [MarshalAs(UnmanagedType.Bool)] bool ignoreCheck, [MarshalAs(UnmanagedType.Bool)] bool preventPending, SafeWaitHandle cancelEvent, DismProgressCallback progress, IntPtr userData);
}
}
}
}

0 comments on commit 5d12437

Please sign in to comment.