ProvideBrokeredServiceAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.ServiceBroker

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Produces registration for a Visual Studio package that leads to the package to be loaded when a specified service is requested.

public ref class ProvideBrokeredServiceAttribute : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public class ProvideBrokeredServiceAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideBrokeredServiceAttribute = class
    inherit RegistrationAttribute

Public Class ProvideBrokeredServiceAttribute
Inherits RegistrationAttribute

Inheritance: Attribute

RegistrationAttribute
ProvideBrokeredServiceAttribute

Derived: Microsoft.VisualStudio.Shell.ProvideFileSystemProviderAttribute

Microsoft.VisualStudio.Shell.ServiceBroker.ProvideBrokeredServiceHubServiceAttribute

Attributes: AttributeUsageAttribute

Constructors

ProvideBrokeredServiceAttribute(String, String)	Initializes a new instance of the ProvideBrokeredServiceAttribute class.
ProvideBrokeredServiceAttribute(String)	Initializes a new instance of the ProvideBrokeredServiceAttribute class.

Fields

AllowGuestClientsRegValue	The registry value to store the security context
AudienceRegValue	The registry value to denote the scope of a service
BrokeredServiceRegKey	The registry key for BrokeredServices
DefaultAudience	The default value for Audience.

Properties

AllowTransitiveGuestClients	Gets or sets a value indicating whether guest clients are allowed to transitively acquire this service. By default (`false`), only owners are allowed to access a brokered service. To opt-in to allowing guests to acquire the proffered service, set this to `true`. By setting this to `true` the service now has sole responsibility in correctly using IAuthorizationService to authorize sensitive operations.
Audience	Gets or sets a value indicating which clients should be allowed to directly acquire this service. Audiences may be bitwise-OR'd together to expand the set of clients that are allowed to acquire this service.
Name	Gets the name of the service (same as Name.)
TypeId	Override the TypeID property in order to let the RegistrationAttribute derived classes to work with System.ComponentModel.TypeDescriptor.GetAttributes(...). An attribute derived from this one will have to override this property only if it needs a better control on the instances that can be applied to a class. (Inherited from RegistrationAttribute)
Version	Gets or sets the version of the proffered service (same as Version.)

Methods

GetPackageGuid(RegistrationAttribute+RegistrationContext)	Gets a GUID for the package that proffers this service.
GetPackageRegKeyPath(Guid)	Gets the registry path (relative to the registry root of the application) of the VSPackage. (Inherited from RegistrationAttribute)
GetRegistryRoot(String, Version)	Returns the VS-hive relative path to the key under which a brokered service is registered.
Register(RegistrationAttribute+RegistrationContext)	Registers this VSPackage with a given context, when called by an external registration tool such as regpkg.exe. For more information, see Registering VSPackages.
SetRegistryValues(RegistrationAttribute+RegistrationContext, RegistrationAttribute+Key)	Sets the values in the specified registry key.
Unregister(RegistrationAttribute+RegistrationContext)	Called to unregister this attribute with the given context.

Applies to

Share via