「ライブラリの基礎 - C++DLL」の版間の差分

== 概要 ==

<br><br>

== DllImport属性 ==

<code>DLLImport</code>属性は、DLLエントリポイントを定義する関数を記述することで、DLLファイルに定義された関数を呼び出すことができる。<br>

  [ DllImport( "DLL名" ) ]

<br>

また、DLLファイルに定義された関数を、関数名または序数で指定するには、<code>DllImport</code>属性の<code>EntryPoint</code>フィールドを使用する。<br>

<br>

以下の例では、<code>EntryPoint</code>フィールドを使用して、<code>MessageBoxA</code>をMsgBoxAに置き換える方法を示している。<br>

  using System;

  using System.Runtime.InteropServices;

     internal static extern int MsgBoxA(IntPtr hWnd, string lpText, string lpCaption, uint uType);

  }

<br>

また、以下の例では、DLLファイルに定義された関数を序数で指定している。<br>

  [DllImport("DllName", EntryPoint = "Functionname")]

  [DllImport("DllName", EntryPoint = "#123")]  // 序数を使用するには、序数値の前にシャープ記号#を付ける必要がある

<br>

<code>DllImport</code>属性には、DLLファイル名を指定する以外にも、下表のような引数を与えることができる。<br>

<center>

|-

|-

|-

|-

|-

|-

| PreserveSig || 定義通りのメソッドのシグネチャを維持するかどうか指定する。

|-

|}

</center>

<br>

<center>

|-

|-

| Cdecl || 呼び出し元がスタックを消去する。<br>これを使用すると、<code>varargs</code>で関数を呼び出すことができる。<br>これは、<code>printf</code>関数等の可変長引数のメソッドの呼び出しで使用する。

以下の例では、呼び出し規約を適用する方法をCdeclとしている。<br>

これは、呼び出し元がスタックをクリーンアップするために使用する必要がある。<br>

  using System;

  using System.Runtime.InteropServices;

     }

  }

詳細は、以下のMSDNのWebサイトを参照すること。<br>

[https://msdn.microsoft.com/ja-jp/library/system.runtime.interopservices.callingconvention.aspx CallingConvention 列挙型 (System.Runtime.InteropServices) | MSDN]<br>

== StructLayout属性 ==

StructLayout属性とは、クラスまたは構造体のデータメンバを、メモリ内でどのように配置するかを表す。<br>

  [ StructLayout( LayoutKind列挙 ) ]

<br>

下表に、LayoutKind列挙子を示す。<br>

</center>

<br>

  [StructLayout( LayoutKind.Sequential )]

  public struct Position

     public double z;

  }

<br>

詳細は、以下のMSDNのWebサイトを参照すること。<br>

<br>

以下の例では、UInt32型はCLSに準拠しないため、<code>CLSCompliant(false)</code>と指定する必要がある。<br>

  [CLSCompliant( false )]

  public int SetValue( UInt32 value );

<br>

以下の例では、CLSCompliantAttribute属性をアセンブリ全体に適用する。<br>

  using System;

  [assembly: CLSCompliant(true)]

<br>

詳細は、以下のMSDNのWebサイトを参照すること。<br>

詳細は、以下のMSDNのWebサイトを参照すること。<br>

[https://msdn.microsoft.com/ja-jp/library/system.runtime.interopservices.marshalasattribute.aspx MarshalAsAttribute クラス (System.Runtime.InteropServices) | MSDN]<br>

  // パラメータへの適用

  public void M1([MarshalAs(UnmanagedType.LPWStr)]string msg)

     return "Hello World";

  }

<br><br>

</center>

<br>

  void Method([in] int[] array);

<br><br>

<center>

|-

|-

|-

|-

| SHORT (short) || short (System.Int16) ||  

| WORD (unsigned short) || ushort (System.UInt16) ||  

|-

|-

|-

| BOOL (long) || bool (System.Boolean) ||  

| CHAR (char) || 文字を渡すとき<br>char (System.Char)<br>文字を受け取るとき<br>StringBuilder ||  

|-

|-

|-

| LPCSTR (const char *, const char[])<br>LPCWSTR (const wchar_t *, const wchar_t[]) || 文字を渡すとき<br>string (System.String)<br>文字を受け取るとき<br>System.Text.StringBuilder ||  

|-

| FLOAT (float) || float (System.Single) ||  

|-

| DOUBLE (double) || double (System.Double) ||  

|}

</center>

<br><br>

例えば、C++ DLLから次のような関数がエクスポートされているとする。<br>

<br>

<br>

<br>

<br>

以下の例では、C++ DLLを呼ぶC# EXEのソースコードを記述している。<br>

   

  // 呼び出し元の関数名を変更する

   

  {

     // 2バイトのメモリ確保

   

     // C++ DLLの関数を呼ぶ

   

     // 2バイトのメモリをshort型に変換

   

     // メモリの開放

     Marshal.FreeHGlobal(buffer);

   

  }

<br>

<code>IntPtr</code>型の変数は様々なものが入る。<br>

ネイティブコードと.NET Frameworkでは型の管理方法が違うため、実際には型の相互変換(マーシャリング)が行われる。<br>

<br>

なお、Windows APIではBOOL型の実体はLONG型なので、.NET Frameworkではboolの代わりにintを指定することも可能である。<br>

このセクションでは、C# EXEからC++ DLLへ配列を渡す方法を記載する。<br>

<br>

まず、以下にC++ DLLを記述する。<br>

  // SampleDLL.h

   

  #pragma once

<br>

  // SampleDll.cpp

   

  #include "SampleDll.h"

   

  {

     for (int i = 0; i < length; i++)

     }

  }

<br>

  // モジュール定義ファイル

  // SampleDll.def

  EXPORTS

           ; 公開する関数名をリストアップ

<br>

次に、C# EXEからC++ DLLを呼び出す方法を記述する。<br>

# 使用したアンマネージド配列のメモリを解放する。

<br>

  namespace SampleEXE

  {

   

     static void Main()

     {

       // 配列の定義

   

       // アンマネージド配列のメモリの確保

   

       // C++ DLLに配列を渡す(ポインタを渡す)

   

       // アンマネージドメモリの解放

       Marshal.FreeCoTaskMem(ptrRet);

     }

  }

C++ DLLの作成方法は[[ライブラリの基礎 - DLLの作成(C/C++/MFC)|ライブラリの基礎 - DLLの作成(C/C++/MFC)]]を参照する。<br>

<br>

下記にもC++ DLLを記述する。<br>

   

<br>

   

  #include <stdio.h>

  #include "SampleDll.h"

   

  {

   

  {

   

  double __stdcall SampleFunc01(int a)

     printf("------------------------\r\n");

  }

   

  {

     printf("index = %d\r\n", st.index);

     printf("name = %s\r\n", st.name);

  }

   

  {

     memset(pStructure, 0, sizeof(SampleStruct2));

     for(int i = 0; i < pStructure->length; i++)

     {

     }

     printf("------------------------\r\n");

  }

   

  LIBRARY SampleDll

  EXPORTS

           ; 公開する関数名をリストアップ

<br>

次に、C# EXEからC++ DLLを呼び出す方法を記述する。<br>

<br>

C++では構造体のサイズはコンパイル時に決定されるが、C#では実行時に決定される。<br>

したがって、C#側で構造体のサイズを予め指定する必要がある。<br>

<br>

  using System;

  using System.Text;

     {

       /// <summary>

       /// </summary>

   

       /// <summary>

       /// </summary>

   

       /// <summary>

       /// </summary>

       /// <param name="pst">受け渡す構造体の先頭アドレスを示すポインタを指定する</param>

   

       /// <summary>

       /// LayoutKind.Sequentialを指定することで、C/C++同様、変数の宣言順通りにメモリに配置されるようになる

       /// </summary>

       {

           /// <summary>

       static void Main(string[] args)

       {

   

   

           {

             index = 4,

           };

   

   

           // SampleStruct2構造体のサイズを取得する

           try

           {

             {

                 // IntPtr型からdouble型の数値を取得するときは、一度Int64型に変換して、これをBitConverter.Int64BitsToDoubleメソッドでdouble型に変換する

                 Console.WriteLine("data[{0}] = {1}", i, BitConverter.Int64BitsToDouble(v));

             }

           {

             // 必ずメモリを解放する

           }

       }

     }

  }

<br>

<br>

  // SampleDLL.h

   

  int __stdcall SampleCallback(int handle, int lPalam);

<br>

  // SampleDll.cpp

   

     return iRet;

  }

<br>

  // モジュール定義ファイル

  // SampleDll.def

           ; 公開する関数名をリストアップ

           SampleCallback  @1

<br>

次に、C# EXEからC++ DLLを呼び出す方法を記述する。<br>

<br>

以下の例では、ManagedCallBackというデリゲートを宣言している。<br>

C++ DLLのSampleCallBack関数にデリゲートを引数として渡すことで、既知のコールバック形式に自動的に変換される。<br>

  using System;

  using System.Runtime.InteropServices;

     class Program

     {

         private static extern int SampleCallback(ManagedCallBack CallBack, int lPalam);

     }

  }

== トラブル対処 ==