Keysight Pathwave 89600 VSA .NET API
GetEnumAsInt32 Method
See Also 
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace > EnumUtilities Class : GetEnumAsInt32 Method


target
The object on which to access the flags-type enumerated property.
propertyName
The name of the flag-type enumerated property.

Glossary Item Box

This method retrieves the value of the specified property as a 32-bit integer.

Syntax

Visual Basic (Declaration) 
Public Shared Function GetEnumAsInt32( _
   ByVal target As RemotableObject, _
   ByVal propertyName As String _
) As Integer
C# 
public static int GetEnumAsInt32( 
   RemotableObject target,
   string propertyName
)
C++/CLI 
public:
static int GetEnumAsInt32( 
   RemotableObject^ target,
   String^ propertyName
)

Parameters

target
The object on which to access the flags-type enumerated property.
propertyName
The name of the flag-type enumerated property.

Return Value

A 32-bit integer value representing the current value of the property.

Exceptions

ExceptionDescription
System.ArgumentExceptionIs raised if either argument is null, or if the propertyName property cannot be found on target.
System.InvalidOperationExceptionIs raised of the type of the named property is not a flag-type enumeration.

Remarks

Some 3rd party packages are unable to manipulate flag-type enumerations. This method allows such packages to retrieve a flag-type enumerated value as a 32-bit integer. The package can then use bitwise integer operations to test for specific flags.

Requirements

Target Platforms: Windows 11 Professional or Enterprise; Windows 10 Professional, Enterprise, or Education (64-bit)

See Also