RodlResource

Overview

The RodlResource class is used to simplify access to RODL resources embedded into an assembly.

The RodlResource class also contains static methods that allow to get all RODL resources from the current application domain (using the RodlMerger class to concatenate resources).

This functionality is used by the static HtmlServerInfo class to obtain the server's documentation. HTTP-based server channels use the RodlResource class to provide RODL resources to the client.

Location

 

constructor

 

constructor(assembly: Assembly)

 

RodlResource(Assembly assembly)

 

Sub New(assembly As Assembly)

Parameters:

  • assembly:

AddIgnoredAssembly

 

class method AddIgnoredAssembly(assembly: Assembly)

 

static void AddIgnoredAssembly(Assembly assembly)

 

Shared Sub AddIgnoredAssembly(assembly As Assembly)

Parameters:

  • assembly:

GetRodl

Returns the RODL resource found in the provided assembly to the constructor.

 

method GetRodl: Stream

 

Stream GetRodl()

 

Function GetRodl() As Stream

GetSystemRodl

Returns a Stream object containing all RODL resources from the current application domain. Also, all IRodlProvider instances registered via the RegisterRodlProvider method are queried for custom RODL resources.

 

class method GetSystemRodl: Stream

 

static Stream GetSystemRodl()

 

Shared Function GetSystemRodl() As Stream

RegisterRodlProvider

 

class method RegisterRodlProvider(provider: IRodlProvider)

 

static void RegisterRodlProvider(IRodlProvider provider)

 

Shared Sub RegisterRodlProvider(provider As IRodlProvider)

Parameters:

  • provider:

RemoveIgnoredAssembly

 

class method RemoveIgnoredAssembly(assembly: Assembly)

 

static void RemoveIgnoredAssembly(Assembly assembly)

 

Shared Sub RemoveIgnoredAssembly(assembly As Assembly)

Parameters:

  • assembly:

UnregisterRodlProvider

 

class method UnregisterRodlProvider(provider: IRodlProvider)

 

static void UnregisterRodlProvider(IRodlProvider provider)

 

Shared Sub UnregisterRodlProvider(provider As IRodlProvider)

Parameters:

  • provider:

 

AddIgnoredAssembly

 

class method AddIgnoredAssembly(assembly: Assembly)

 

static void AddIgnoredAssembly(Assembly assembly)

 

Shared Sub AddIgnoredAssembly(assembly As Assembly)

Parameters:

  • assembly:

GetSystemRodl

Returns a Stream object containing all RODL resources from the current application domain. Also, all IRodlProvider instances registered via the RegisterRodlProvider method are queried for custom RODL resources.

 

class method GetSystemRodl: Stream

 

static Stream GetSystemRodl()

 

Shared Function GetSystemRodl() As Stream

RegisterRodlProvider

 

class method RegisterRodlProvider(provider: IRodlProvider)

 

static void RegisterRodlProvider(IRodlProvider provider)

 

Shared Sub RegisterRodlProvider(provider As IRodlProvider)

Parameters:

  • provider:

RemoveIgnoredAssembly

 

class method RemoveIgnoredAssembly(assembly: Assembly)

 

static void RemoveIgnoredAssembly(Assembly assembly)

 

Shared Sub RemoveIgnoredAssembly(assembly As Assembly)

Parameters:

  • assembly:

UnregisterRodlProvider

 

class method UnregisterRodlProvider(provider: IRodlProvider)

 

static void UnregisterRodlProvider(IRodlProvider provider)

 

Shared Sub UnregisterRodlProvider(provider As IRodlProvider)

Parameters:

  • provider:

 

constructor

 

constructor(assembly: Assembly)

 

RodlResource(Assembly assembly)

 

Sub New(assembly As Assembly)

Parameters:

  • assembly:

GetRodl

Returns the RODL resource found in the provided assembly to the constructor.

 

method GetRodl: Stream

 

Stream GetRodl()

 

Function GetRodl() As Stream