HostedEventProvider.HostedEventProviderArguments Property

Gets the collection of initialization values for the hosted event provider.

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

Syntax

'Declaration
Public ReadOnly Property HostedEventProviderArguments As HostedEventProviderArgumentCollection

public HostedEventProviderArgumentCollection HostedEventProviderArguments { get; }

public:
property HostedEventProviderArgumentCollection^ HostedEventProviderArguments {
    HostedEventProviderArgumentCollection^ get ();
}

/** @property */
public HostedEventProviderArgumentCollection get_HostedEventProviderArguments ()

public function get HostedEventProviderArguments () : HostedEventProviderArgumentCollection

Property Value

A HostedEventProviderArgumentCollection object.

Remarks

Each hosted event provider may use 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.

Example

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

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

HostedEventProvider Class
HostedEventProvider Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Defining Hosted Event Providers
Arguments Element for HostedProvider (ADF)