VarTypeFromType Method

Determines an OLE automation VarType that corresponds to a given CLR (.NET) System.Type.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Shared Function VarTypeFromType( _
   ByVal type As Type _
) As VarType

'Usage
 
Dim type As Type
Dim value As VarType
 
value = VarTypeUtilities.VarTypeFromType(type)

[NotNull()]
public static VarType VarTypeFromType( 
   Type type
)

[NotNull()]
public:
static VarType^ VarTypeFromType( 
   Type^ type
)

Parameters

type: The System.Type for which the corresponding OLE Automation type should be determined.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

The resulting VarType. If it cannot be specifically determined, a VarTypes.Empty is returned.

Because there is an implicit conversion from VarType to System.Int32 and VarTypes, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the return value in place of an integer (System.Int32) (representing the numerical value of the COM VARTYPE), or in place a VarTypes enumeration value. When the implicit conversion operators are not supported (such as with Python.NET), you can use the ToInt32 or ToVarTypes static method instead.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

VarTypeUtilities Class
VarTypeUtilities Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.