Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Latest commit

 

History

History
180 lines (140 loc) · 4.32 KB

IoTProductSettingsXML.md

File metadata and controls

180 lines (140 loc) · 4.32 KB
Raw

IoTProductSettingsXML

SHORT DESCRIPTION

Describes the IoTProductSettingsXML Class

LONG DESCRIPTION

This class helps in managing the product settings XML configuration.

Constructors

IoTProductSettingsXML(String SettingsXML, Boolean Create, String oemName, String familyName, String skuNumber, String baseboardManufacturer, String baseboardProduct, String pkgDir)

Constructor. If the file is not present and the Create flag is false, it throws an exception.

[IoTProductSettingsXML]::new(String SettingsXML, Boolean Create, String oemName, String familyName, String skuNumber, String baseboardManufacturer, String baseboardProduct, String pkgDir)

Properties

BuildConfigKeys

This is the array of keys supported in the GetBuildConfig/SetBuildConfig methods.

Name: BuildConfigKeys
Type: String[]
Hidden: False
Static: True

FileName

Filename of the product settings xml

Name: FileName
Type: String
Hidden: False
Static: False

SettingsKeys

This is the array of keys supported in the GetSettings/SetSettings methods.

Name: SettingsKeys
Type: String[]
Hidden: False
Static: True

SMBIOSKeys

This is the array of keys supported in the GetSMBIOS/SetSMBIOS methods.

Name: SMBIOSKeys
Type: String[]
Hidden: False
Static: True

XmlDoc

XML document object for the product settings xml

Name: XmlDoc
Type: System.Xml.XmlDocument
Hidden: False
Static: False

Methods

CreateSettingsXML(String oemName, String familyName, String skuNumber, String baseboardManufacturer, String baseboardProduct, String pkgDir)

GetBuildConfig(String config)

Returns an hashtable of config elements with the values. See ConfigKeys for the list of keys returned.

Name: GetBuildConfig
Return Type: System.Collections.Hashtable
Hidden: False
Static: False
Definition: System.Collections.Hashtable GetBuildConfig(String config)

GetSettings()

Returns an hashtable of config elements with the values. See ConfigKeys for the list of keys returned.

Name: GetSettings
Return Type: System.Collections.Hashtable
Hidden: False
Static: False
Definition: System.Collections.Hashtable GetSettings()

GetSMBIOS()

Returns an hashtable of config elements with the values. See ConfigKeys for the list of keys returned.

Name: GetSMBIOS
Return Type: System.Collections.Hashtable
Hidden: False
Static: False
Definition: System.Collections.Hashtable GetSMBIOS()

GetSupportedBuildConfigs()

Returns the array of supported build configs in this product.

Name: GetSupportedBuildConfigs
Return Type: String[]
Hidden: False
Static: False
Definition: String[] GetSupportedBuildConfigs()

IsBuildConfigSupported(String config)

Returns if the buildconfig is defined.

Name: IsBuildConfigSupported
Return Type: Boolean
Hidden: False
Static: False
Definition: Boolean IsBuildConfigSupported(String config)

SetBuildConfig(String config, System.Collections.Hashtable buildcfg)

Sets the current config elements with the hashtable values provided. See ConfigKeys for the supported keys.

Name: SetBuildConfig
Return Type: Void
Hidden: False
Static: False
Definition: Void SetBuildConfig(String config, System.Collections.Hashtable buildcfg)

SetSettings(System.Collections.Hashtable config)

Sets the current config elements with the hashtable values provided. See ConfigKeys for the supported keys.

Name: SetSettings
Return Type: Void
Hidden: False
Static: False
Definition: Void SetSettings(System.Collections.Hashtable config)

SetSMBIOS(System.Collections.Hashtable config)

Sets the current config elements with the hashtable values provided. See ConfigKeys for the supported keys.

Name: SetSMBIOS
Return Type: Void
Hidden: False
Static: False
Definition: Void SetSMBIOS(System.Collections.Hashtable config)

EXAMPLES

A Sample use of this class

    $samplea = New-IoTProductSettingsXML "$env:SRC_DIR\Products\SampleA\SampleASettings.xml"
    $samplea_smbios = $samplea.GetSMBIOS()

NOTE

None

TROUBLESHOOTING NOTE

None

SEE ALSO

KEYWORDS

  • IoT Core Product Settings