c++でのGetCellDataについて

Question

前提・実現したいこと

Com初心者です。
現在cellからデータを取り出すコードを書いている途中で、
参考にと渡されたコードがあるのですが、
どういった処理を行っているのかいまいちわかっていないことと、
Variantを使用していますが、VariantInit()やVariantClear()がありません。
これって解放されていることになってるのでしょうか。

該当のソースコード

.h
void GetCellData(const char* sc,const char* ec,CStringArray &dt,bool formula = false);
void GetCellData(int cols,int rows,int cole,int rowe,CStringArray &dt,bool formula = false);
CExcelCtrl();
virtual ~CExcelCtrl();

_Application	m_excel;

.cpp
CExcelCtrl::CExcelCtrl()
{
	CoInitialize(NULL);
}

CExcelCtrl::~CExcelCtrl()
{
	CoUninitialize();
}

void CExcelCtrl::GetCellData(int cols,int rows,int cole,int rowe,CStringArray &dt,bool formula)
{
	CString sc,ec;
	sc.Format("%s%d",Num2Col(cols),rows);
	ec.Format("%s%d",Num2Col(cole),rowe);
	GetCellData(sc,ec,dt,formula);
}

void CExcelCtrl::GetCellData(const char* sc,const char* ec,CStringArray &dt,bool formula)
{
	try{
		_Worksheet ws = m_excel.GetActiveSheet();
		Range range = ws.GetRange(COleVariant(sc),COleVariant(ec));

		COleVariant data;
		if(formula)	data = range.GetFormula();
		else		data = range.GetValue(vtMissing);

		COleSafeArray sa;
		sa.Attach(data);

		long rowmax,colmax;
		sa.GetUBound(1,&rowmax);
		sa.GetUBound(2,&colmax);

		CString str;
		VARIANT val;
		long idx[2];

		dt.RemoveAll();
		for(long row = 1;row <= rowmax;row++){
			idx[0] = row;
			for(long col = 1;col <= colmax;col++){
				idx[1] = col;
				sa.GetElement(idx,&val);
				switch(val.vt){
				case	VT_R8:
					str.Format("%1.2f", val.dblVal);
					break;
				case	VT_BSTR:
					str.Format("%s",(CString)val.bstrVal);
					::SysFreeString(val.bstrVal);
					break;
				case	VT_EMPTY:
					str.Empty();
					break;
				}
				dt.Add(str);
			}
		}
	}catch(COleDispatchException *e){
		AfxMessageBox(e->m_strDescription,MB_ICONEXCLAMATION);
		dt.RemoveAll();
	}
}

補足情報（FW/ツールのバージョンなど）

windows10/64bit
visual studio 2017

Answer 1

Variantを使用していますが、VariantInit()やVariantClear()がありません。
これって解放されていることになってるのでしょうか。

この辺はC++とマイクロソフトのMFC(Microsoft Foundation Class)と言うものをある程度理解しないと分かりづらいのですが、C言語で生でCOMを扱う際のVARIANT型などをC++のクラスでラップしたCOleVariantクラス
や COleSafeArray クラスがあり、これらクラスのメソッドであるClear等に隠されています。
ご提示のコードは一見そのClearメソッドすら見えないのでアレレ？となってしまいますが、これらクラスのデストラクター内でも呼ばれていたりして、クラスのインスタンスが破棄されるときに適切に呼び出されます。

ご提示のコードの場合はautoでCOleSafeArray saを宣言したのち、sa.Attach(data)で実体が当てはめられ、そのインスタンス変数のスコープの終わりでデストラクトされる際にClearが呼ばれます。MFCはVisual Studio のバージョンにもよりますがソースコードが提供されています。Visual Studio を適切にインストールした後でデバッグ時にトレースするとそのコードに行き当たりますので、実際に追ってみるとよいです。C言語でのCOMプログラミングの参考にもなります。例えばCOleSafeArrayクラスですと、デバッグでのトレース時に下図のように行き当たります。

COMは（もともと難解な上に）最近ではCやC++を使ったサンプルや情報が少ないので大変かもしれませんが、がんばってください。

Comments

[beginner101]

ご回答ありがとうございます。
なるほど別のところに用意されていて、書いて無くても大丈夫だったのですか。
ここら辺が理解できなかったので、助かりました。

Answer 2

vt含めた各メンバは sa.GetElement(で適切に代入されているはずなのでVariantInit()やVariantClear()は不要と思われます。
なお、配列操作部分のコードは基本的にColesafearray::getelementのサンプルコードと同一のようです。
一点気になるのはVT_BSTRの場合に::SysFreeStringが必要かどうですが、ヘルプのコードには記載されていませんね。
VARIANT型を知ってみるのVARIANT型を使ってみるによるとBSTR型の場合は必要そうに思えますが、元のCOleSafeArray内部で解放しているので不要なのかもしれません。

Comments

[beginner101]

ご回答ありがとうございます。
サンプルコードの提示もありがたいです。（ここを参考にしたのがわかりました。）
一旦SysFreeStringを抜きにして、解放されているか確かめてみます。

[beginner101]

そこを削除したらメモリリークが発生しました。
何故か分かりますでしょうか。

[8524ba23]

すみません。明確な理由は分かりません。
ということは、ヘルプサンプルでもメモリーリーク発生するということでしょうか？

[atata0319]

これはサンプルの不具合ですね。この場合は明示的にSysFreeStringが必要になります。内部で使用されているAPIのSafeArrayGetElementは格納されている値のコピーを返します。APIのサンプルでは適切に解放するコードになっていますね。

[beginner101]

ご回答ありがとうございます。
なるほど解放に必要なコードがサンプルに無いんですね。
このままコードで試したらメモリは解放されていたので、bstrを使用する場合、
SysFreeStringは必要と覚えておきます。

[8524ba23]

atata0319さん、コメント＆情報ありがとうございます。
あらら、サンプルの不具合なんですね…
ちなみにですが、SafeArrayGetElement利用のAPIサンプルの公開URLをもしご存知でしたら教えていただけないでしょうか？
SysFreeStringが必要である根拠なり（サンプルコード）が知りたいのですが、ネット上では
http://forums.codeguru.com/showthread.php?157122-SafeArrayGetElement-problem
しかヒットしませんでした。

[atata0319]

https://docs.microsoft.com/en-us/windows/desktop/api/oleauto/nf-oleauto-safearraygetelement
です。Remarksには値はコピーされることが記載されています。
一番下のサンプルでは受け取った値はすべてVariantClearで解放していますが、これがBSTRを直接使用する場合、SysFreeStringに変更することがあると言うことの根拠ですね。

[8524ba23]

> ～すべてVariantClearで解放していますが～
なるほど。VariantClearとSysFreeStringの関係に気づけませんでした。
ありがとうございます。