VBFixedStringAttribute Class
 

Indicates that a string should be treated as if it were fixed length.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Inheritance Hierarchy
SystemObject
   SystemAttribute
    Microsoft.VisualBasicVBFixedStringAttribute

Syntax
[AttributeUsageAttribute(AttributeTargets.Field, Inherited = false, 
	AllowMultiple = false)]
public sealed class VBFixedStringAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Field, Inherited = false, 
	AllowMultiple = false)]
public ref class VBFixedStringAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Field, Inherited = false,
    AllowMultiple = false)>]
type VBFixedStringAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Field, Inherited := False,
	AllowMultiple := False)>
Public NotInheritable Class VBFixedStringAttribute
	Inherits Attribute
Constructors
NameDescription
System_CAPS_pubmethod VBFixedStringAttribute

Initializes the value of the SizeConst field.

Properties
NameDescription
System_CAPS_pubproperty

Gets the length of the string.

System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

Methods
NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations
NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Remarks

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

Examples
Structure Person
    Public ID As Integer
    Public MonthlySalary As Decimal
    Public LastReviewDate As Long
    <VBFixedString(15)> Public FirstName As String
    <VBFixedString(15)> Public LastName As String
    <VBFixedString(15)> Public Title As String
    <VBFixedString(150)> Public ReviewComments As String
End Structure
System_CAPS_noteNote

The VBFixedStringAttribute is informational and cannot be used to convert a variable length string to a fixed string. The purpose of this attribute is to modify how strings in structures and non-local variables are used by methods or API calls that recognize the VBFixedStringAttribute. Keep in mind that this attribute does not change the actual length of the string itself.

Version Information
.NET Framework
Available since 1.1
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top