Skip to content

getimageproperties-method-in-class-sms_imagepackage.md

Latest commit

 

History

History
56 lines (40 loc) · 2.18 KB

getimageproperties-method-in-class-sms_imagepackage.md

File metadata and controls

56 lines (40 loc) · 2.18 KB
title GetImageProperties Method in SMS_ImagePackage
description Reads all metadata from the specified .wim source file for an image to an XML string.
ms.date 09/20/2016
ms.subservice sdk
ms.topic reference
ms.collection tier3

GetImageProperties Method in Class SMS_ImagePackage

The GetImageProperties Windows Management Instrumentation (WMI) class method, in Configuration Manager, reads all metadata from the specified .wim source file for an image to an XML string.

The following syntax is simplified from Managed Object Format (MOF) code and defines the method.

Syntax

SInt32 GetImageProperties(
      String SourceImagePath,
      String ImageProperty
);

Parameters

SourceImagePath Data type: String

Qualifiers: [in]

Path to the .wim source file to query for metadata, for example, \\server\share\boot.wim.

ImageProperty Data type: String

Qualifiers: [out]

XML document containing the image metadata.

Return Values

An SInt32 data type that is 0 to indicate success or non-zero to indicate failure.

For information about handling returned errors, see About Configuration Manager Errors.

Remarks

This method accesses the source .wim file metadata by using the ImageProperty property of SMS_ImagePackage Server WMI Class. For more information, see How to View the Properties for an Operating System Image.

Requirements

Runtime Requirements

For more information, see Configuration Manager Server Runtime Requirements.

Development Requirements

For more information, see Configuration Manager Server Development Requirements.

See Also

SMS_ImagePackage Server WMI Class ReloadImageProperties Method in Class SMS_ImagePackage