AdapterCacheGetDescription Method

Gets the adapter name and description for the given type parsed from the DescriptionAttribute.

Definition

Namespace: Gemstone.Timeseries.Adapters
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.160 -- Release Build+69269a1754081bcb38397d2d6a05132ae03c7054

C#View Source Request Example

public static (string adapterName, string description) GetDescription(
	this Type type
)

VBView Source Request Example

<ExtensionAttribute>
Public Shared Function GetDescription ( 
	type As Type
) As (adapterName As String, description As String)

C++View Source Request Example

public:
[ExtensionAttribute]
static ValueTuple<String^, String^> GetDescription(
	Type^ type
)

JavaScriptView Source Request Example

Gemstone.Timeseries.Adapters.AdapterCache.GetDescription = function(type);

Parameters

type Type: [Missing <param name="type"/> documentation for "M:Gemstone.Timeseries.Adapters.AdapterCache.GetDescription(System.Type)"]

Return Value

ValueTupleString, String

[Missing <returns> documentation for "M:Gemstone.Timeseries.Adapters.AdapterCache.GetDescription(System.Type)"]

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Type. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

If no DescriptionAttribute can be found, adapter name defaults to [!:Type.Name] and description defaults to FullName.