ExcelのVBAで使えるDLLを、C++（Visual Studio 2017）で作る。・・・その４．１（配列準備編）

はじめに
SAFEARRAY
- SAFEARRAY構造体
  - cDims
  - fFeatures
  - cbElements
  - pvData
  - rgsabound
次回予告
過去掲載分

はじめに

前回の文字列の受け渡しでは、VARIANTを使いました。（自分でもびっくり）

今回の配列でも、int* とか short* とかを使うのかと思いきや
SAFEARRAYなるものを使うことになります。

VBA の配列は OLE の SafeArrays です。C/C++ については、Windows OLE/COM ヘッダーファイル内で SAFEARRAY として定義されています。
https://docs.microsoft.com/ja-jp/office/client-developer/excel/how-to-access-dlls-in-excel

ということで、配列の１回目は、SAFEARRAYとはどのようなものなのか、調べてみます。

SAFEARRAY

docs.microsoft.com

SAFEARRAY構造体

こんな感じで定義されています。

typedef struct tagSAFEARRAY {
  USHORT         cDims;
  USHORT         fFeatures;
  ULONG          cbElements;
  ULONG          cLocks;
  PVOID          pvData;
  SAFEARRAYBOUND rgsabound[1];
} SAFEARRAY;

メンバ	内容
cDims	配列の次元数
fFeatures	フラグ
cbElements	配列の１要素のサイズ
cLocks	対応するロック解除なしでアレイがロックされた回数。原文：The number of times the array has been locked without a corresponding unlock. よくわかりません・・・ m(_ _)m
pvData	配列要素の先頭データを指すポインタ
rgsabound	配列の指定次元の１．要素数２．指定できるインデックスの下限

cDims

配列の次元数が格納されている。
１次元配列なら、１
２次元配列なら、２
３次元配列なら、３
と言った具合です。

fFeatures

項目	値	備考
FADF_AUTO	0x0001	配列はスタック上に割り当てられる。
FADF_STATIC	0x0002	配列は静的に割り当てられる。
FADF_EMBEDDED	0x0004	配列は構造体に組み込まれる。
FADF_FIXEDSIZE	0x0010	配列はリサイズ、再割り当てできない。
FADF_RECORD	0x0020	レコードを含む配列。
FADF_HAVEIID	0x0040	インターフェイスを識別するIIDを持つ配列。FADF_DISPATCHまたはFADF_UNKNOWNも設定されている場合にのみ設定される。
FADF_HAVEVARTYPE	0x0080	VARIANT型を持つ配列。
FADF_BSTR	0x0100	BSTR型の配列。
FADF_UNKNOWN	0x0200	IUnknown*型の配列。
FADF_DISPATCH	0x0400	IDispatch*型の配列。
FADF_VARIANT	0x0800	VARIANT型の配列。
FADF_RESERVED	0xF008	将来のために予約済み。

VBA側から渡す配列によって異なり、以下のようになるようです。
f:id:Z1000S:20191113210606j:plain

DateTime型、Currency型はいずれも数値型と同じになりました。

cbElements

配列の要素１個のサイズ。
VBAのIntegerの配列なら２、Longの配列なら４
MSのサイトには、「データオブジェクトのサイズは含まれない」と書かれている（が理解できていない・・・）。

pvData

データを指すポインタ。

１次元配列の場合は、普通にインクリメントしても（範囲内であれば）大丈夫。
２次元以上の配列の場合、インクリメントしても、おそらくほとんどの人が意図した要素のアドレスを指していないと思う。

なぜなら、メモリ上の要素の並びが以下のようになっているから。

元データ（Byte型の３次元配列）

x(0, 0, 0) = &H0
x(0, 0, 1) = &H1
x(0, 1, 0) = &H10
x(0, 1, 1) = &H11
x(1, 0, 0) = &H20
x(1, 0, 1) = &H21
x(1, 1, 0) = &H30
x(1, 1, 1) = &H31

SAFEARRAYのpvDataの状態（メモリデータ）
f:id:Z1000S:20191114215409j:plain
次項のrgsaboundでも書いているが、インデックスの並びが左右逆になっている。

混乱する元になるので、多次元配列の場合は、ポインタを使わないようにした方がよさそう・・・

rgsabound

各次元の境界情報
下記構造体で定義されている。

typedef struct tagSAFEARRAYBOUND {
  ULONG cElements;
  LONG  lLbound;
} SAFEARRAYBOUND, *LPSAFEARRAYBOUND;

単一要素の配列となっているのは、
多次元配列の場合に、インデックスに指定する値を変えることで各次元の情報が得られるような仕組みとするためと思われる。
指定できるインデックスは、0 ～ cDims -1
ただし、インデックスの指定には注意が必要。
３次元配列を例にすると、下表のようになる。
配列の１番右の次元がのインデックスが０となる。