TemplateSummaryCollection object
The TemplateSummaryCollection object represents a collection of TemplateSummary objects. Each object in the collection contains a template description, a locale ID (LCID), and the template name. The name and the description are both written in the language identified by the LCID. For example, if the LCID equals 1033, the name and the descriptive information are both written in U.S. English. For a complete list of the LCIDs supported by Microsoft, see List of Locale ID (LCID) Values as Assigned by Microsoft. You can retrieve the collection by calling the Summaries property on the RightsTemplate object.
Members
The TemplateSummaryCollection object has these types of members:
Methods
The TemplateSummaryCollection object has these methods.
| Method | Description |
|---|---|
| Add | Adds an object to the collection (inherited from IList). |
| Clear | Removes all objects from the collection (inherited from IList). |
| Contains | Determines whether the collection contains a specific object (inherited from IList). |
| CopyTo | Copies the collection elements to an array, starting at a specified index (inherited from ICollection). |
| IndexOf | Retrieves the index of a specific object in the collection (inherited from IList). |
| Insert | Inserts an object in the collection at the specified index (inherited from IList). |
| Remove | Removes the first occurrence of the specified object from the collection (inherited from IList). |
| RemoveAt | Removes the object at the specified index from the collection (inherited from IList). |
Properties
The TemplateSummaryCollection object has these properties.
| Property | Description |
|---|---|
| Count |
Retrieves the number of objects contained in the collection (inherited from ICollection). |
| Item |
Specifies or retrieves the object at the specified index (inherited from IList). |
Examples
DIM config_manager
DIM admin_role
' *******************************************************************
' Create and initialize a ConfigurationManager object.
SUB InitObject()
CALL WScript.Echo( "Create ConfigurationManager object...")
SET config_manager = CreateObject _
("Microsoft.RightsManagementServices.Admin.ConfigurationManager")
CheckError()
CALL WScript.Echo( "Initialize...")
admin_role=config_manager.Initialize(false,"localhost",80,"","","")
CheckError()
END SUB
' *******************************************************************
' Add summary information to the template.
SUB AddSummaryData()
DIM template_manager
DIM templateColl
DIM templateObj
' Retrieve the RightsTemplatePolicy object.
SET template_manager = config_manager.RightsTemplatePolicy
CheckError()
' Retrieve the rights template collection.
SET templateColl = template_manager.RightsTemplateCollection
CheckError()
' Retrieve the first template in the collection.
SET templateObj = template_manager.RightsTemplateCollection.Item(0)
CheckError()
' Add summary information.
SET summary = CreateObject( _
"Microsoft.RightsManagementServices.Admin.TemplateSummary")
summary.LanguageId = 1033
summary.Name = "Scripting test template"
summary.Description = "Scripting test template Desc"
templateObj.Summaries.Add( summary )
CheckError()
' Update the templates on the server.
template_manager.RightsTemplateCollection.Update( templateObj )
CheckError()
END SUB
' *******************************************************************
' Error checking function.
FUNCTION CheckError()
CheckError = Err.number
IF Err.number <> 0 THEN
CALL WScript.Echo( vbTab & "*****Error Number: " _
& Err.number _
& " Desc:" _
& Err.Description _
& "*****")
WScript.StdErr.Write(Err.Description)
WScript.Quit( Err.number )
END IF
END FUNCTION
' *******************************************************************
' Generate a runtime error.
SUB RaiseError(errId, desc)
CALL Err.Raise( errId, "", desc )
CheckError()
END SUB
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| Assembly |
|