Function PyCom_PyObjectFromVariant

com/win32com/src/oleargs.cpp:321–504

Given a variant, turn it into a Python object of the closest type. Note that ByRef params are not supported here.

// Given a variant, turn it into a Python object of the closest type.
// Note that ByRef params are not supported here.
PyObject *PyCom_PyObjectFromVariant(const VARIANT *var)
{
	HRESULT		hr;
	VARIANT		varValue;
	PyObject *	result = NULL;

	if (!var) {
		Py_INCREF(Py_None);
		return Py_None;
	}
	/* skip past any variant references to a "real" variant 
	  (Why do we do this?  Why is it only a VARIANT?  whats the story, morning glory?
	*/
	while ( V_VT(var) == (VT_BYREF | VT_VARIANT) )
		var = V_VARIANTREF(var);

	/* ### note: we shouldn't see this, it is illegal in a VARIANT */
	if (V_ISVECTOR(var)) {
		return OleSetTypeError(_T("Cant convert vectors!"));
	}

	if (V_ISARRAY(var)) {
		SAFEARRAY FAR *psa;
		if (V_ISBYREF(var))
			psa = *V_ARRAYREF(var);
		else
			psa=V_ARRAY(var);
		if (psa==NULL) { // A NULL array
			Py_INCREF(Py_None);
			return Py_None;
		}
		VARENUM rawVT = (VARENUM)(V_VT(var) & VT_TYPEMASK);
		return PyCom_PyObjectFromSAFEARRAY(psa, rawVT);
	}

	/* get a fully dereferenced copy of the variant */
	/* ### we may want to optimize this sometime... avoid copying values */
	VariantInit(&varValue);
	VariantCopyInd(&varValue, (VARIANT*)var);

	switch (V_VT(&varValue))
	{
		case VT_BOOL:
			result = V_BOOL(&varValue) ? Py_True : Py_False;
			Py_INCREF(result);
			break;

		case VT_UI1:
		case VT_UI2:
		case VT_UI4:
		case VT_UINT:
			hr = VariantChangeType(&varValue, &varValue, 0, VT_UI4);
			if ( FAILED(hr) )
			{
				TCHAR buf[200];
				wsprintf(buf, _T("Error converting integer variant (%08lx)"), hr);
				OleSetTypeError(buf);
				break;