Share via

HostedEventProviderArgument Class

  • Article

Represents one name/value pair for a hosted event provider argument. Not all hosted event providers use arguments.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public NotInheritable Class HostedEventProviderArgument
    Inherits NamedSmoObject

public sealed class HostedEventProviderArgument : NamedSmoObject

public ref class HostedEventProviderArgument sealed : public NamedSmoObject

public final class HostedEventProviderArgument extends NamedSmoObject

public final class HostedEventProviderArgument extends NamedSmoObject

Remarks

Each hosted event provider can have required and optional arguments. For example, the standard file system watcher event provider requires three arguments (such as WatchDirectory) and has four optional arguments. If you are using a standard event provider, arguments are described in the Standard Event Providers section. If you are using a custom event provider, the provider should include documentation about its arguments.

Inheritance Hierarchy

System.Object
   Microsoft.SqlServer.Management.Smo.SmoObjectBase
     Microsoft.SqlServer.Management.Smo.SqlSmoObject
       Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Nmo.HostedEventProviderArgument

Example

The following examples show how to define an event provider argument and add it to the collection of arguments for a hosted event provider:

HostedEventProviderArgument fileArg_Directory = 
    new HostedEventProviderArgument(
    flightEventProvider, "WatchDirectory");
fileArg_Directory.Value = sampleDirectory + @"\Events";
flightEventProvider.HostedEventProviderArguments.Add(
    fileArg_Directory);

Dim fileArg_Directory As HostedEventProviderArgument = _
    New HostedEventProviderArgument(flightEventProvider, _
        "WatchDirectory")
fileArg_Directory.Value = sampleDirectory + "\Events"
flightEventProvider.HostedEventProviderArguments.Add( _
    fileArg_Directory)

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

HostedEventProviderArgument Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Defining Hosted Event Providers
Argument Element for HostedProvider/Arguments (ADF)