VBFixedArrayAttribute Class

Definition

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Source:

VBFixedArrayAttribute.vb

Indicates that an array in a structure or non-local variable should be treated as a fixed-length array.

public ref class VBFixedArrayAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field, AllowMultiple=false, Inherited=false)]
public sealed class VBFixedArrayAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field, AllowMultiple=false, Inherited=false)>]
type VBFixedArrayAttribute = class
    inherit Attribute

Public NotInheritable Class VBFixedArrayAttribute
Inherits Attribute

Inheritance

Object

Attribute

VBFixedArrayAttribute

Attributes

AttributeUsageAttribute

Examples

Structure Book
    <VBFixedArray(4)> Public Chapter() As Integer
End Structure

Sub WriteData()
    Dim FileNum As Integer = FreeFile()
    Dim MyBook As Book
    ReDim MyBook.Chapter(4)
    ' Add code to populate the array.
    MyBook.Chapter(0) = 1
    MyBook.Chapter(1) = 2
    MyBook.Chapter(2) = 3
    MyBook.Chapter(3) = 4
    MyBook.Chapter(4) = 5
    ' Write the array to a file.
    FileOpen(FileNum, "C:\testfile", OpenMode.Binary,
             OpenAccess.Write, OpenShare.Default)
    FilePut(FileNum, MyBook) ' Write data.
    FileClose(FileNum)
End Sub

Note

The VBFixedArrayAttribute is informational and does not allocate any storage. The purpose of this attribute is to modify how arrays in structures and non-local variables are used by methods or API calls that recognize the VBFixedArrayAttribute. Keep in mind that this attribute does not convert a variable length array to a fixed array and that you must still allocate array storage using Dim or ReDim statements.

Remarks

Visual Basic arrays are of variable length by default. This attribute is useful when using Visual Basic file input and output functions, such as FileGet and FilePut, and API calls that require fixed-length arrays.

Constructors

VBFixedArrayAttribute(Int32, Int32)	Initializes the value of the Bounds property.
VBFixedArrayAttribute(Int32)	Initializes the value of the Bounds property.

Properties

Bounds	Returns the bounds of the array.
Length	Returns the size of the array.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• MarshalAsAttribute
• FileGet(Int32, Array, Int64, Boolean, Boolean)
• FilePut(Int32, Array, Int64, Boolean, Boolean)
• FileOpen(Int32, String, OpenMode, OpenAccess, OpenShare, Int32)
• Attributes (Visual Basic)