DismGetFeatureInfo function

Gets detailed info from for the specified feature.

Syntax

HRESULT WINAPI DismGetFeatureInfo(
  _In_     DismSession           Session,
  _In_     PCWSTR                FeatureName,
  _In_opt_ PCWSTR                Identifier,
  _In_opt_ DismPackageIdentifier PackageIdentifier,
  _Out_    DismFeatureInfo       **FeatureInfo
);

Parameters

Session [in]
A valid DismSession. The DismSession must be associated with an image. You can associate a session with an image by using the DismOpenSession.

FeatureName [in]
The name of the feature that you want to get more information about.

Identifier [in, optional]
Optional. Either an absolute path to a .cab file or the package name, depending on the PackageIdentifier parameter value.

PackageIdentifier [in, optional]
Optional. A valid DismPackageIdentifier enumeration value.

Value Description
PackageName Use this value when you want to specify a package by using the package name.
PackagePath Use this value when you want to specify a package by using an absolute path to a .cab file.
PackageNone Not a valid value for this function.

FeatureInfo [out]
A pointer to the address of an array of DismFeatureInfo structures.

Return value

Returns S_OK on success.

Remarks

You can use this function to get the custom properties of a feature. If the feature has custom properties, they will be stored in the CustomProperty field as an array. Not all features have custom properties.

Example

HRESULT hr = S_OK;
DismFeatureInfo FeatureInfo;
hr = DismGetFeatureInfo(Session, "Xps-Foundation-Xps-Viewer", NULL, NULL, &FeatureInfo);

Requirements

Requirement Description
Supported host platforms DISM API can be used on any operating system supported by the Windows Assessment and Deployment Kit (Windows ADK). For more information, see the Windows ADK Technical Reference.
Supported image platforms Windows 7, Windows Server 2008 R2, Windows PE 3.0, Windows 8, Windows Server 2012, Windows Preinstallation Environment (Windows PE) 4.0, Windows 8.1, Windows Server 2012 R2, Windows 10, Windows Server 2016
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Header DismAPI.h
Library DismAPI.lib
DLL DismAPI.dll

See also

DismEnableFeature

DismDisableFeature

DismGetFeatureInfo

DismGetFeatureParent

DismDelete