API Guide
601355 Rev A Getting Started 1-15
Getting Started
Naming Conventions

The table below describes the API naming conventions:

Item Description
Handles Handle names start with the VST prefix, followed by the specific
object name, and end with the HANDLE suffix. The name should be
in all capitals. For example: VST_DRIVE_HANDLE
Types Types are defined in a client-accessed header file begin with the
VST prefix. For example: VST_DRIVE_ID
Definitions Definitions that are defined in the client definition header file
should begin with the VSD prefix. For example:
VSD_DRIVE_NAME_LEN
Enumerations Enumerations have two con ventio ns to follo w. The type begins with
the VST prefix. The values inside the enumeration structure begin
with the VSE prefix.
For example:
typedef enum {
VSE_DRIVETYPE_NONE
= 0,
VSE_DRIVETYPE_MAGTAPE =1
} VST_DRIVE_TYPE
Global Variables Global variables begin with the VSG prefix. For example:
VSG_ERROR_CODE
Identifiers Identifiers that are used in the “assignment” and “accessor”
functions to identify the field being accessed within each handle
begin with the VSID prefix. The following identifier is for a drive
identifier, for example: VSID_DRIVE_ID