UserRightsItemCollection object

The UserRightsItemCollection object contains a collection of UserRightsItem objects, each of which identifies a specific user and the rights granted that user. You can retrieve the collection by calling the UserRightsItems property on the RightsTemplate object.

Members

The UserRightsItemCollection object has these types of members:

Methods

The UserRightsItemCollection object has these methods.

MethodDescription
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).

GrantOwnerFullRights

Grants full rights to the content owner.

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 UserRightsItemCollection object has these properties.

PropertyDescription

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 user rights to the template. 

SUB AddRights()

  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 rights information.
  SET rights = CreateObject( _
      "Microsoft.RightsManagementServices.Admin.UserRightsItem")
  rights.UserId = "someone@example.com"
  rights.WellKnownRights = _
        config_manager.Constants.TemplateRightExtract + _
        config_manager.Constants.TemplateRightPrint + _
        config_manager.Constants.TemplateRightForward
  rights.CustomRights.Add("CUSTOMRIGHTA")
  rights.CustomRights.Add("CUSTOMRIGHTB")
  Err.Clear()
  templateObj.UserRightsItems.Add( rights )
  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

Microsoft.RightsManagementServices.Admin.dll

See also

Active Directory Rights Management Services Scripting API Reference
RightsTemplate

 

 

Show:
© 2015 Microsoft