This page refers to an older version of the product.
View the current version of the online Help.

Configuration Helper Object

In this section:

• About the Configuration Helper Object
• Configuration Helper Object Methods

About the Configuration Helper Object

The Configuration Helper object provides useful functionality that is not provided by the configuration model, such as the ability to load and save configurations.

The methods listed below provide error reporting as a HRESULT which can be tested for in VBScript using the Err object. Success is reported as S_OK which is 0.

In case of error, most of the time the Configuration Helper Object returns the error code 2147500037 which is 0x80004005 in hex and defined as E_FAIL in COM. The other most common error is 2147942405 which is 0x80070005 in hex and defined as

Configuration Helper Object Methods

LoadLiveConfiguration (method)

Returns:

BSTR - The xml representation of the live configuration.

HRESULT - Returns S_OK if successful.

SaveLiveConfiguration (method)

Returns:

HRESULT - Returns S_OK if successful.

Parameters:

BSTR - The xml representation of the configuration loaded from disk.

LoadLocalConfiguration (method)

Returns:

BSTR - The xml representation of the configuration loaded from disk.

HRESULT - Returns S_OK if successful.

Parameters:

BSTR - The full file path of the configuration to load.

SaveLocalConfiguration (method)

Parameters:

BSTR - The full file path of the configuration to load.

BSTR - The xml representation of the configuration to save.

ReadNumCertificatesFromFile (method)

Returns:

LONG - The number of certificates used to sign the specified executable file.

Parameters:

BSTR - The full file path of the executable file used in determining the certificate count.

ReadCertificateFromFile (method)

Returns:

BSTR - The raw certificate data.

Parameters:

BSTR - The full file path of the executable file from which the certificate will be read.

LONG - The index of the certificate to read.

ReadSha1HashFromFile (method)

Returns:

BSTR - The hash value.

HRESULT - Returns S_OK if successful.

Parameters:

BSTR - The full file path of the file for which the hash will be generated.

DefaultConfiguration (property)

This BSTR property contains the xml representation of the default configuration.

The DefaultConfiguration( ) method only returns a configuration in the English language. This means that some group names and other text in the configuration may not be in the native language of the operating system, which can result in the configuration not being applied correctly. For non-English operating systems it is necessary to export the default configuration from the product console on a native operating system. This can be stored as a file on the network or distributed to the machine where the configuration scripting will be performed. Once this is done, use the LoadLocalConfiguration( ) method in place of the DefaultConfiguration( ). This will produce the same configuration but in the correct native language.

LoadLocalConfigurationWithAuditing (method)

Returns:

BSTR - The xml representation of the live configuration

BSTR - The xml representation of the live Auditing configuration

HRESULT - Return S_OK if successful

Parameters:

BSTR - The full file path of the configuration to load

SaveLocalConfigurationWithAuditing (method)

Parameters:

BSTR - The full file path of the configuration to save

BSTR - The xml representation of the configuration to save

BSTR - The xml representation of the auditing configuration to save

SaveLocalConfigurationWithAuditingFile (method)

Parameters:

BSTR - The full file path of the configuration to save

BSTR - The xml representation of the configuration to save

BSTR - The full file path of the Auditing.xml to save

LoadLiveConfigurationWithAuditing (method)

Returns:

BSTR - The xml representation of the live configuration

BSTR - The xml representation of the live Auditing configuration

HRESULT - Return S_OK if successful

SaveLiveConfigurationWithAuditing (method)

Parameters:

BSTR - The xml representation of the configuration to save

BSTR - The xml representation of the auditing configuration to save

SaveLiveConfigurationWithAuditingFile (method)

Parameters:

BSTR - The xml representation of the configuration to save

BSTR - The full file path of the Auditing.xml to save

EncryptSharedKey (method)

Parameters:

BSTR - The shared key used in Policy Change Requests

Returns:

BSTR - Encrypted version of the shared key

HRESULT - Return S_OK if successful

LoadLocalConfigurationHandle

Parameters:

BSTR - The full file path of the configuration to load

Returns:

VARIANT - Opened file handle

BSTR - The xml representation of the configuration

HRESULT - Return S_OK if successful

LoadLiveConfigurationHandle

Returns:

VARIANT - Opened file handle

BSTR - The xml representation of the live configuration

HRESULT - Return S_OK if successful

LoadLocalConfigurationHandleWithAuditing

Parameters:

BSTR - The full file path of the configuration to load

Returns:

BSTR - The xml representation of the configuration

BSTR - The xml representation of the auditing configuration

VARIANT - Opened file handle

HRESULT - Return S_OK if successful

LoadLiveConfigurationHandleWithAuditing

Returns:

BSTR - The xml representation of the configuration

BSTR - The xml representation of the auditing configuration

VARIANT - Opened file handle

HRESULT - Return S_OK if successful

SaveLocalConfigurationHandle

Parameters:

BSTR - The full file path of the configuration to save

BSTR - The xml representation of the configuration

VARIANT - Opened file handle

SaveLiveConfigurationHandle

Parameters:

BSTR - The xml representation of the configuration

VARIANT - Opened file handle

SaveLocalConfigurationHandleWithAuditing

Parameters:

BSTR - The full file path of the configuration to save

BSTR - The xml representation of the configuration

BSTR - The xml representation of the auditing configuration

VARIANT - Opened file handle

SaveLiveConfigurationHandleWithAuditing

Parameters:

BSTR - The xml representation of the configuration

BSTR - The xml representation of the auditing configuration

VARIANT - Opened file handle