How to: Control the Availability of a Variable

How to: Control the Availability of...

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

Visual Basic Programming Guide

How to: Control the Availability of a Variable

You control the availability of a variable by specifying its access level. The access level determines what code has permission to read or write to the variable.

Member variables (defined at module level and outside any procedure) default to public access, which means any code that can see them can access them. You can change this by specifying an access modifier.
Local variables (defined inside a procedure) nominally have public access, although only code within their procedure can access them. You cannot change the access level of a local variable, but you can change the access level of the procedure that contains it.

For more information, see Access Levels in Visual Basic.

Private and Public Access

To make a variable accessible only from within its module, class, or structure

Place the Dim Statement (Visual Basic) for the variable inside the module, class, or structure, but outside any procedure.
Include the Private (Visual Basic) keyword in the Dim statement.
You can read or write to the variable from anywhere within the module, class, or structure, but not from outside it.

To make a variable accessible from any code that can see it

For a member variable, place the Dim statement for the variable inside a module, class, or structure, but outside any procedure.
Include the Public (Visual Basic) keyword in the Dim statement.
You can read or write to the variable from any code that interoperates with your assembly.

-or-

For a local variable, place the Dim statement for the variable inside a procedure.
Do not include the Public keyword in the Dim statement.
You can read or write to the variable from anywhere within the procedure, but not from outside it.

Protected and Friend Access

You can limit the access level of a variable to its class and any derived classes, or to its assembly. You can also specify the union of these limitations, which allows access from code in any derived class or in any other place in the same assembly. You specify this union by combining the Protected and Friend keywords in the same declaration.

To make a variable accessible only from within its class and any derived classes

Place the Dim statement for the variable inside a class, but outside any procedure.
Include the Protected (Visual Basic) keyword in the Dim statement.
You can read or write to the variable from anywhere within the class, as well as from within any class derived from it, but not from outside any class in the derivation chain.

To make a variable accessible only from within the same assembly

Place the Dim statement for the variable inside a module, class, or structure, but outside any procedure.
Include the Friend (Visual Basic) keyword in the Dim statement.
You can read or write to the variable from anywhere within the module, class, or structure, as well as from any code in the same assembly, but not from outside the assembly.

Example

The following example shows declarations of variables with Public, Protected, Friend, Protected Friend, and Private access levels. Note that when the Dim statement specifies an access level, you do not need to include the Dim keyword.

Public Class classForEverybody
Protected Class classForMyHeirs
Friend stringForThisProject As String
Protected Friend stringForProjectAndHeirs As String
Private numberForMeOnly As Integer

Security

The more restrictive the access level of a variable, the smaller the chances that malicious code can make improper use of it.

Concepts

Access Levels in Visual Basic

Reference

Dim Statement (Visual Basic)

Public (Visual Basic)

Protected (Visual Basic)

Friend (Visual Basic)

Private (Visual Basic)