DtsLogProviderAttribute.IconResource Property

Article
12/03/2008

Gets or sets the icon associated with a log provider.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Property IconResource As String

public string IconResource { get; set; }

public:
property String^ IconResource {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_IconResource ()

/** @property */
public void set_IconResource (String value)

public function get IconResource () : String

public function set IconResource (value : String)

Property Value

A string that identifies the icon resource of the log provider.

Remarks

When specified, this property identifies the icon shown in the Business Intelligence Development Studio when the log provider is displayed.

The string should contain the name of the assembly and the name of the icon file. To embed an icon file as a resource in an assembly using Visual Studio .NET, set the icon's Build Action attribute to Embedded Resource.

Example

The following example shows a log provider class that provides an icon resource. In this example, the icon file is named MyLogProviderIcon.ico, and the assembly name is MyLogProvider.

using System;
using Microsoft.SqlServer.Dts.Runtime;

namespace Microsoft.Samples.SqlServer.Dts
{
[DtsLogProvider(LogProviderType = "MyLOG", 
  DisplayName = "MyCustomLogProvider ", 
  Description = "Custom Log Provider")]
public class MyCustomLogProvider : LogProviderBase
{
    // Your custom log provider code here.
}
}

Imports System
Imports Microsoft.SqlServer.Dts.Runtime

<DtsLogProvider(LogProviderType:="MyLOG", _
DisplayName:="MyCustomLogProvider ", _
Description:="Custom Log Provider")> _
Public Class MyCustomLogProvider
  Inherits LogProviderBase
  ' Your custom log provider code here.
End Class

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