LEADTOOLS Image File Support (Leadtools.Codecs assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
GetCodecInformation Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class : GetCodecInformation Method



codecName
The name of the codec to query. The codec name is usually a string containing 3 characters. The codec name is not case sensitive.
codecName
The name of the codec to query. The codec name is usually a string containing 3 characters. The codec name is not case sensitive.
Gets information about the specified codec.

Syntax

Visual Basic (Declaration) 
Public Function GetCodecInformation( _
   ByVal codecName As String _
) As CodecsCodecInformation
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim codecName As String
Dim value As CodecsCodecInformation
 
value = instance.GetCodecInformation(codecName)
C# 
public CodecsCodecInformation GetCodecInformation( 
   string codecName
)
C++/CLI 
public:
CodecsCodecInformation GetCodecInformation( 
   String^ codecName
) 

Parameters

codecName
The name of the codec to query. The codec name is usually a string containing 3 characters. The codec name is not case sensitive.

Return Value

A CodecsCodecInformation onject containing Information about the codec.

Example

This example gets and then updates information about the ptoca (ptk) filter.

Visual BasicCopy Code
Public Sub GetCodecInformationExample()
   Dim codecs As RasterCodecs = New RasterCodecs()

   Dim codecInfo As CodecsCodecInformation = codecs.GetCodecInformation("Tif")
   Console.WriteLine("CheckedByInformation : {0}", codecInfo.CheckedByInformation)
   Console.WriteLine("ExtensionList : {0}", codecInfo.ExtensionList)
   Console.WriteLine("IsPresent : {0}", codecInfo.IsPresent.ToString())
   Console.WriteLine("IsSlowInformation : {0}", codecInfo.IsSlowInformation.ToString())
   Console.WriteLine("LoadMode : {0}", codecInfo.LoadMode.ToString())
   Console.WriteLine("Name : {0}", codecInfo.Name)

   ' change the extensions that the ptk filter tries to handle
   codecInfo.ExtensionList = "ptk;ptoka;ptoca;ptca;ptka"
   codecs.SetCodecInformation(codecInfo)

   ' re-display the new settings
   codecInfo = codecs.GetCodecInformation("tif")
   Console.WriteLine("ExtensionList : {0}", codecInfo.ExtensionList)

   ' Clean up
   codecs.Dispose()
End Sub
C#Copy Code
public void GetCodecInformationExample()
{
   RasterCodecs codecs = new RasterCodecs();

   CodecsCodecInformation codecInfo = codecs.GetCodecInformation("Tif");
   Console.WriteLine("CheckedByInformation : {0}", codecInfo.CheckedByInformation);
   Console.WriteLine("ExtensionList : {0}", codecInfo.ExtensionList);
   Console.WriteLine("IsPresent : {0}", codecInfo.IsPresent.ToString());
   Console.WriteLine("IsSlowInformation : {0}", codecInfo.IsSlowInformation.ToString());
   Console.WriteLine("LoadMode : {0}", codecInfo.LoadMode.ToString());
   Console.WriteLine("Name : {0}", codecInfo.Name);

   // change the extensions that the ptk filter tries to handle
   codecInfo.ExtensionList = "ptk;ptoka;ptoca;ptca;ptka";
   codecs.SetCodecInformation(codecInfo);

   // re-display the new settings
   codecInfo = codecs.GetCodecInformation("tif");
   Console.WriteLine("ExtensionList : {0}", codecInfo.ExtensionList);

   // Clean up
   codecs.Dispose();
}
SilverlightCSharpCopy Code
SilverlightVBCopy Code

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also