Package Class

Metadata for other information classes such as EventInfo, TargetInfo, ActionInfo, and others listed in Remarks.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance
    Microsoft.SqlServer.Management.XEvent.Package

Namespace:  Microsoft.SqlServer.Management.XEvent
Assembly:  Microsoft.SqlServer.Management.XEvent (in Microsoft.SqlServer.Management.XEvent.dll)

Syntax

'Declaration
Public NotInheritable Class Package _
    Inherits SfcInstance
'Usage
Dim instance As Package
public sealed class Package : SfcInstance
public ref class Package sealed : public SfcInstance
[<SealedAttribute>]
type Package =  
    class 
        inherit SfcInstance 
    end
public final class Package extends SfcInstance

The Package type exposes the following members.

Properties

  Name Description
Protected property AbstractIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public property ActionInfoSet Gets the ActionInfoCollection object contained by the package.
Public property Capabilities Gets an integer value that represents the capabilities.
Public property CapabilitiesDesc Gets a string value that contains the capabilities description.
Public property Description Gets a string that contains the description of the Package object.
Public property EventInfoSet Gets the EventInfoCollection that the package contains.
Public property ID Gets a Guid object that contains the Id.
Public property IdentityKey Gets the identity key of the Package object.
Public property MapInfoSet Gets the MapInfoCollection contained by the package.
Public property Metadata Returns metadata about the instance and its domain. (Inherited from SfcInstance.)
Public property ModuleAddress Gets a Byte value that contains the module address.
Public property ModuleID Gets a Guid object that contains the module Id.
Public property Name Gets a string value that contains the name of the package.
Public property Parent Gets or sets the parent XEStore object.
Public property PredCompareInfoSet Gets the PredCompareInfoCollection contained by the package.
Public property PredSourceInfoSet Gets the PredSourceInfoCollection contained by the package.
Public property Properties Returns a collection instance properties. (Inherited from SfcInstance.)
Protected property State Returns the state of the SfcInstance object. (Inherited from SfcInstance.)
Public property TargetInfoSet Gets the TargetInfoCollection contained by the package.
Public property TypeInfoSet Gets the TypeInfoCollection contained by the package.
Public property Urn Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance.)

Top

Methods

  Name Description
Protected method CreateIdentityKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Discover Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Equals (Inherited from Object.)
Protected method GetChildCollection Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetDomain Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetObjectFactory Gets the SQL Foundation Class object factory for the Package object.
Public method GetPropertySet Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance.)
Public method GetType (Inherited from Object.)
Protected method GetTypeMetadataImpl Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method InitializeUIPropertyState Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Protected method OnPropertyMetadataChanges Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance.)
Protected method OnPropertyValueChanges Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance.)
Public method Refresh Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance.)
Protected method ResetKey Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance.)
Public method Serialize Serializes the instance to XML. (Inherited from SfcInstance.)
Public method ToString Returns a string representation of the instance Urn. (Inherited from SfcInstance.)

Top

Events

  Name Description
Public event PropertyChanged CLS-compliant event for property changes. (Inherited from SfcInstance.)
Public event PropertyMetadataChanged CLS-compliant event for property metadata changes. (Inherited from SfcInstance.)

Top

Remarks

The Package class is the parent for other metadata classes, including EventInfo, TargetInfo, ActionInfo, TypeInfo, PredSourceInfo, PredCompareInfo, MapInfo, EventColumnInfo, TargetColumnInfo, and MapValueInfo.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.XEvent Namespace