How to Read a Configuration Manager Site Control File Embedded Property List
Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2
In Microsoft System Center Configuration Manager 2007, you read an embedded property list from a site control file resource by getting the SMS_EmbeddedPropertyList object for the embedded object from the resources PropLists property array.
An embedded property list has the following properties that you can set. For more information, see SMS_EmbeddedPropertyList.
Value | Description |
---|---|
PropertyListName |
The embedded property name. |
Values |
An array of string values. Each array item represents a single property list item. |
Warning
Making changes to the site control file can cause irreparable damage to your Configuration Manager 2007 site.
To read a site control file embedded property list
Set up a connection to the SMS Provider. For more information, see About the SMS Provider in Configuration Manager.
Using the connection object from step one, get a site control file resource. For more information, see About the Configuration Manager Site Control File.
Get the SMS_EmbeddedPropertyList for the required embedded property list.
Access the property list values by using the SMS_EmbeddedPropertyList object Values property array.
Example
The following example method populates the supplied values parameter with the Values array of the embedded property list (SMS_EmbeddedPropertyList) identified by the propertyListName parameter. true is returned if the embedded property list is found; otherwise, false is returned.
You can update the embedded property list values that are returned from this method by using the method in How to Write a Configuration Manager Site Control File Embedded Property List.
To view code that calls these functions, see How to Read and Write to the Configuration Manager Site Control File by Using Managed Code or see How to Read and Write to the Configuration Manager Site Control File by Using WMI.
For information about calling the sample code, see Calling Configuration Manager Code Snippets.
Function GetScfEmbeddedPropertyList(resource, _
propertyListName, _
ByRef values)
Dim scfPropertyList
If IsNull(resource.PropLists) = True Then
GetScfPropertyList = False
Exit Function
End If
For each scfPropertyList in resource.PropLists
if scfPropertyList.PropertyListName = propertyListName Then
' Found property list, so return the values array.
values = scfPropertyList.Values
GetScfEmbeddedPropertyList = True
Exit Function
End If
Next
' Did not find the property list.
GetScfEmbeddedPropertyList = False
End Function
public bool GetScfEmbeddedPropertyList(
IResultObject resource,
string propertyListName,
out ArrayList values)
{
values = new ArrayList();
try
{
if (resource.EmbeddedPropertyLists.ContainsKey(propertyListName))
{
values.AddRange(resource.EmbeddedPropertyLists[propertyListName]["Values"].StringArrayValue);
return true;
}
}
catch(SmsException e)
{
Console.WriteLine("Couldn't get the embedded property list: " + e.Message);
}
return false;
}
The sample method has the following parameters:
Parameter |
Type |
Description |
Resource |
|
The site control file resource that contains the embedded property. |
propertyListName |
|
The embedded property list to be read. |
Values |
|
The SMS_EmbeddedProperty class Values property. An array of string values. |
Compiling the Code
The C# example has the following compilation requirements:
Namespaces
System
System.Collections.Generic
System.Collections
System.Text
Microsoft.ConfigurationManagement.ManagementProvider
Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine
Assembly
microsoft.configurationmanagement.managementprovider
adminui.wqlqueryengine
Robust Programming
For more information about error handling, see About Configuration Manager Errors.
Security
For more information about securing Configuration Manager applications, see About Securing Configuration Manager Applications.
See Also
Tasks
How to Write a Configuration Manager Site Control File Embedded Property
How to Write a Configuration Manager Site Control File Embedded Property List
Concepts
About the Configuration Manager Site Control File
How to Read a Configuration Manager Site Control File Embedded Property
How to Read a Configuration Manager Site Control File Embedded RegMultiString List
How to Write a Configuration Manager Site Control File Embedded RegMultiString List
How to Read and Write to the Configuration Manager Site Control File by Using Managed Code
How to Read and Write to the Configuration Manager Site Control File by Using WMI