ExcludedApplicationCollection object

The ExcludedApplicationCollection object contains a collection of ExcludedApplication objects that represent applications prohibited from decrypting RMS-protected content. You can retrieve this collection by calling the Applications property on the ExclusionPolicy object.

Members

The ExcludedApplicationCollection object has these types of members:

Methods

The ExcludedApplicationCollection 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).

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

Refresh

Refreshes the collection from the collection saved on the server.

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

PropertyDescription

Count

Retrieves the number of objects contained in the collection (inherited from ICollection).

Enabled

Specifies or retrieves a Boolean value that indicates whether the collection is enabled.

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

' *******************************************************************
' Exclude an application

SUB Exclude()

  DIM exclusionPolicy
  DIM excludedAppColl   
  DIM excludedApplication
  DIM minVersion
  DIM maxVersion

  ' Retrieve the ExclusionPolicy object.
  SET exclusionPolicy = config_manager.Enterprise.ExclusionPolicy
  CheckError()

  ' Retrieve the collection of exclusion policies.
  Set excludedAppColl = exclusionPolicy.Applications
  CheckError()

  IF IsObject(excludedAppColl) <> TRUE THEN
    CALL RaiseError(-810, "Cannot retrieve exclusion policies.")
  END IF

  ' Enable application exclusion
  excludedAppColl.Enabled = True

  ' Exclude Notepad.exe.
  SET excludedApplication = CreateObject( _
    "Microsoft.RightsManagementServices.Admin.ExcludedApplication")
  CheckError()
  SET minVersion = CreateObject( _
    "Microsoft.RightsManagementServices.Admin.Version")
  SET maxVersion = CreateObject(_
    "Microsoft.RightsManagementServices.Admin.Version")
  CheckError()
    
  minVersion.Major = 1
  minVersion.Minor = 1
  minVersion.Build = 1
  minVersion.Revision = 1
  maxVersion.Major = 1
  maxVersion.Minor = 1
  maxVersion.Build = 1
  maxVersion.Revision = 1
  excludedApplication.AppName = "Notepad.exe"
  excludedApplication.MinimumVersion = minVersion
  excludedApplication.MaximumVersion = maxVersion

  ' Add the excluded application to the collection, and update
  ' the collection on the server.
  excludedAppColl.Add( excludedApplication )
  CheckError()

  ' Refresh the collection. This is not needed here, but the call
  ' displays the syntax.
  excludedAppColl.Refresh()
  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 [desktop apps only]

Assembly

Microsoft.RightsManagementServices.Admin.dll

See also

Active Directory Rights Management Services Scripting API Reference
ExcludedApplication

 

 

Show:
© 2014 Microsoft. All rights reserved.