C#聲明COM接口淺談
學(xué)習(xí)C#語言時(shí),經(jīng)常會(huì)遇到C#聲明COM接口問題,這里將介紹C#聲明COM接口問題的解決方法。
COM 接口在 C# 中表示為具有 ComImport 和 Guid 屬性的接口。它不能在其基接口列表中包含任何接口,而且必須按照方法在 COM 接口中出現(xiàn)的順序聲明接口成員函數(shù)。
C#聲明COM接口必須包含其基接口的所有成員的聲明,IUnknown 和 IDispatch 的成員除外(.NET 框架將自動(dòng)添加這些成員)。從 IDispatch 派生的 COM 接口必須用 InterfaceType 屬性予以標(biāo)記。
從 C# 代碼調(diào)用 COM 接口方法時(shí),公共語言運(yùn)行庫必須封送與 COM 對(duì)象之間傳遞的參數(shù)和返回值。對(duì)于每個(gè) .NET 框架類型均有一個(gè)默認(rèn)類型,公共語言運(yùn)行庫將使用此默認(rèn)類型在 COM 調(diào)用間進(jìn)行封送處理時(shí)封送。例如,C# 字符串值的默認(rèn)封送處理是封送到本機(jī)類型 LPTSTR(指向 TCHAR 字符緩沖區(qū)的指針)??梢栽贑#聲明COM接口中使用 MarshalAs 屬性重寫默認(rèn)封送處理。
在 COM 中,返回成功或失敗的常用方法是返回一個(gè) HRESULT,并在 MIDL 中有一個(gè)標(biāo)記為"retval"、用于方法的實(shí)際返回值的 out 參數(shù)。在 C#(和 .NET 框架)中,指示已經(jīng)發(fā)生錯(cuò)誤的標(biāo)準(zhǔn)方法是引發(fā)異常。
默認(rèn)情況下,.NET 框架為由其調(diào)用的 COM 接口方法在兩種異常處理類型之間提供自動(dòng)映射。返回值更改為標(biāo)記為 retval 的參數(shù)的簽名(如果方法沒有標(biāo)記為 retval 的參數(shù),則為 void)。標(biāo)記為 retval 的參數(shù)從方法的參數(shù)列表中剝離。任何非成功返回值都將導(dǎo)致引發(fā) System.COMException 異常。此示例顯示用 MIDL 聲明的 COM 接口以及用 C# 聲明的同一接口(注意這些方法使用 COM 錯(cuò)誤處理方法)。
下面是一個(gè)使用C# 映射媒體播放機(jī)COM 對(duì)象的程序。
- using System;
- using System.Runtime.InteropServices;
- namespace QuartzTypeLib
- {
- //聲明一個(gè)COM接口 IMediaControl,此接口來源于媒體播放機(jī)COM類
- [Guid("56A868B1-0AD4-11CE-B03A-0020AF0BA770"),
- InterfaceType(ComInterfaceType.InterfaceIsDual)]
- interface IMediaControl
- { //列出接口成員
- void Run();
- void Pause();
- void Stop();
- void GetState( [In] int msTimeout, [Out] out int pfs);
- void RenderFile(
- [In, MarshalAs(UnmanagedType.BStr)] string strFilename);
- void AddSourceFilter(
- [In, MarshalAs(UnmanagedType.BStr)] string strFilename,
- [Out, MarshalAs(UnmanagedType.Interface)]
- out object ppUnk);
- [return: MarshalAs(UnmanagedType.Interface)]
- object FilterCollection();
- [return: MarshalAs(UnmanagedType.Interface)]
- object RegFilterCollection();
- void StopWhenReady();
- }
- //聲明一個(gè)COM類:
- [ComImport, Guid("E436EBB3-524F-11CE-9F53-0020AF0BA770")]
- class FilgraphManager //此類不能再繼承其它基類或接口
- {
- //這里不能有任何代碼 ,系統(tǒng)自動(dòng)增加一個(gè)缺省的構(gòu)造函數(shù)
- }
- }
- class MainClass
- {
- public static void Main(string[] args)
- {
- //命令行參數(shù):
- if (args.Length != 1)
- {
- DisplayUsage();
- return;
- }
- String filename = args[0];
- if (filename.Equals("/?"))
- {
- DisplayUsage();
- return;
- }
- // 聲明FilgraphManager的實(shí)類對(duì)象:
- QuartzTypeLib.FilgraphManager graphManager =new QuartzTypeLib.FilgraphManager();
- //聲明IMediaControl的實(shí)類對(duì)象::
- QuartzTypeLib.IMediaControl mc =(QuartzTypeLib.IMediaControl)graphManager;
- // 調(diào)用COM的方法:
- mc.RenderFile(filename);
- //運(yùn)行文件.
- mc.Run();
- //暫借停.
- Console.WriteLine("Press Enter to continue.");
- Console.ReadLine();
- }
- private static void DisplayUsage()
- { // 顯示
- Console.WriteLine("媒體播放機(jī): 播放 AVI 文件.");
- Console.WriteLine("使用方法: VIDEOPLAYER.EXE 文件名");
- }
- }
- 運(yùn)行示例:
- 若要顯示影片示例 Clock.avi,請(qǐng)使用以下命令:
- interop2 %windir%\clock.avi
- 這將在屏幕上顯示影片,直到按 ENTER 鍵停止。
- 在 .NET 框架程序中通過DllImport使用 Win32 API
- .NET 框架程序可以通過靜態(tài) DLL 入口點(diǎn)的方式來訪問本機(jī)代碼庫。
DllImport 屬性用于指定包含外部方法的實(shí)現(xiàn)的dll 位置- DllImport 屬性定義如下:
- namespace System.Runtime.InteropServices
- {
- [AttributeUsage(AttributeTargets.Method)]
- public class DllImportAttribute: System.Attribute
- {
- public DllImportAttribute(string dllName) {...}
- public CallingConvention CallingConvention;
- public CharSet CharSet;
- public string EntryPoint;
- public bool ExactSpelling;
- public bool PreserveSig;
- public bool SetLastError;
- public string Value { get {...} }
- }
- }
【編輯推薦】