RightsTemplateCollection.Update method

The Update method updates the template collection on the server database.

Syntax

RightsTemplateCollection.Update( _
  ByVal template _
)

Parameters

template [in]

The RightsTemplate object to be updated. The object must exist on the AD RMS server.

Return value

This method does not return a value.

Remarks

This method updates the collection on the server with your changes while preserving the changes made by others. Call the Refresh method to update your collection from the server database.

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

' *******************************************************************
' Update a Rights Template.

SUB UpdateRightsTest()

  DIM template_manager

  SET template_manager = config_manager.RightsTemplatePolicy
  CheckError()

  ' Retrieve the first template in the collection and change its
  ' summary information.
  SET firstObj = template_manager.RightsTemplateCollection.Item(0)
  firstObj.Summaries.Item(0).Description = "Updated description"
  CheckError()

  ' Update the template on the server.
  template_manager.RightsTemplateCollection.Update( firstObj )
  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
Microsoft.RightsManagementServices.Admin.dll

See also

RightsTemplateCollection