VariantChangeTypeEx - OLE Programmer's Reference

Custom Search

VariantChangeTypeEx

pvargDest, pvargSrc, lcid, wFlags, vtNew)
VARIANTARG FAR* pvargDest
VARIANTARG FAR* pvargSrc
LCID lcid
unsigned short wFlags
VARTYPE vtNew

This function converts a variant from one type to another using a locale ID.

Parameters
pvargDest
Pointer to the VARIANTARG to receive the coerced type. If this is the same as pvargSrc, the variant will be converted in place.

pvargSrc
Pointer to the source VARIANTARG to be coerced.

lcid
The locale ID for the variant to coerce. The locale ID is useful when the type of the source or destination VARIANTARG is VT_BSTR, VT_DISPATCH, or VT_DATE.

wFlags
Flags that control the coercion. The only defined flag is VARIANT_NOVALUEPROP, which prevents the function from attempting to coerce an object to a fundamental type by getting its Value property. Applications should set this flag only if necessary, because it makes their behavior inconsistent with other applications.

tNew

The type to coerce to. If the return code is S_OK, the vt field of the *pvargDest is guaranteed to be equal to this value.

Return Value
The SCODE obtained from the returned HRESULT is one of the following:

SCODE	Meaning
S_OK	Success.
DISP_E_BADVARTYPE	The variant type vtNew is not a valid type of variant.
DISP_E_OVERFLOW	The data pointed to by pvargSrc does not fit in the destination type.
DISP_E_TYPEMISMATCH	The argument could not be coerced to the specified type.
E_INVALIDARG	One of the arguments is invalid.
E_OUTOFMEMORY	Memory could not be allocated for the conversion.

Comments
The VariantChangeTypeEx function handles coercions between the fundamental types (including numeric to string and string to numeric coercions). To change a type with the VT_BYREF flag set to one without VT_BYREF set, VariantChangeTypeEx fetches the referenced value. Objects are coerced to fundamental types by fetching the value of the Value property.

Typically, the implementor of IDispatch::Invoke determines which member is being accessed, then calls VariantChangeType to get the value of one or more arguments. For example, if the IDispatch call specifies a SetTitle member that takes one string argument, the implementor would call VariantChangeTypeEx to attempt to coerce the argument to VT_BSTR. If VariantChangeTypeEx did not return an error, the argument could then be fetched directly from the bstrVal field of the VARIANTARG. If VariantChangeTypeEx returned DISP_E_TYPEMISMATCH, the implementor would set *puArgErr to 0 (indicating the argument in error) and return DISP_E_TYPEMISMATCH from IDispatch::Invoke.

Note that you should not attempt to change the type of a VARIANTARG in the rgvarg array in place.

Arrays of one type can't be converted to arrays of another type with this function.

See Also
VariantChangeType

Last news from Greatis Software

    Nostalgia .Net     .Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More »

Recommended software for developers

    Ultimate Pack     Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More »

    Form Designer .Net     Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More »

    Print Suite .Net     Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More »

    Gradient Controls .Net     Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More »

    Greatis iGrid     iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More »

All the contacts and projects

Dmitry Vasiliev (just.dmitry)

More Online Helps

Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages

greatis just4fun network