VMS Help
Lexicals, F$GETDVI

 *Conan The Librarian

    Returns a specified item of information for a specified device.

    Format

      F$GETDVI(device-name,item)

  1 - Return Value

    Either an integer or a character string, depending on the item
    you request.

  2 - Arguments

 device-name

    Specifies a physical device name or a logical name equated to
    a physical device name. Specify the device name as a character
    string expression.

    After the device-name argument is evaluated, the F$GETDVI
    function examines the first character of the name. If the
    first character is an underscore (_),  the name is considered
    a physical device name; otherwise, a single level of logical name
    translation is performed and the equivalence name, if any, is
    used.

 item

    Specifies the type of device information to be returned. The
    item must be specified as a character string expression. You can
    specify any one of the items listed below:

    ACPPID                  ACPTYPE                 ALL
    ALLDEVNAM               ALLOCLASS               ALT_HOST_AVAIL
    ALT_HOST_NAME           ALT_HOST_TYPE           AVL
    CCL                     CLUSTER                 CONCEALED
    CYLINDERS               DEVBUFSIZ               DEVCHAR
    DEVCHAR2                DEVCLASS                DEVDEPEND
    DEVDEPEND2              DEVLOCKNAM              DEVNAM
    DEVSTS                  DEVTYPE                 DEVICE_TYPE_NAME
    DFS_ACCESS              DIR                     DMT
    DUA                     ELG                     ERRCNT
    EXISTS                  FOD                     FOR
    FREEBLOCKS              FULLDEVNAM              GEN
    HOST_AVAIL              HOST_COUNT              HOST_NAME
    HOST_TYPE               IDV                     LOCKID
    LOGVOLNAM               MAXBLOCK                MAXFILES
    MBX                     MEDIA_ID                MEDIA_NAME
    MEDIA_TYPE              MNT                     MOUNTCNT
    MPDEV_CURRENT_PATH*     MT3_DENSITY             MT3_SUPPORTED
    MULTIPATH*              NET                     NEXTDEVNAM
    ODV                     OPCNT                   OPR
    OWNUIC                  PID                     PREFERRED_CPU
    RCK                     RCT                     REC
    RECSIZ                  REFCNT                  REMOTE_DEVICE
    RND                     ROOTDEVNAM              RTM
    SDI                     SECTORS                 SERIALNUM
    SERVED_DEVICE           SET_HOST_TERMINAL       SHDW_CATCHUP_COPYING
    SHDW_MASTER             SHDW_MASTER_NAME        SHDW_MEMBER
    SHDW_MERGE_COPYING      SHDW_NEXT_MBR_NAME      SHR
    SPL                     SPLDEVNAM               SQD
    STS                     SWL                     TRACKS
    TRANSCNT                TRM                     TT_ACCPORNAM
    TT_ALTYPEAHD            TT_ANSICRT              TT_APP_KEYPAD
    TT_AUTOBAUD             TT_AVO                  TT_BLOCK
    TT_BRDCSTMBX            TT_CHARSET              TT_CRFILL
    TT_CS_KANA              TT_CS_KANJI             TT_CS_HANZI
    TT_CS_HANGUL            TT_CS_HANYU             TT_CS_THAI
    TT_DECCRT               TT_DECCRT2              TT_DECCRT3
    TT_DECCRT4              TT_DIALUP               TT_DISCONNECT
    TT_DMA                  TT_DRCS                 TT_EDIT
    TT_EDITING              TT_EIGHTBIT             TT_ESCAPE
    TT_FALLBACK             TT_HALFDUP              TT_HANGUP
    TT_HOSTSYNC             TT_INSERT               TT_LFFILL
    TT_LOCALECHO            TT_LOWER                TT_MBXDSABL
    TT_MECHFORM             TT_MECHTAB              TT_MODEM
    TT_MODHANGUP            TT_NOBRDCST             TT_NOECHO
    TT_NOTYPEAHD            TT_OPER                 TT_PAGE
    TT_PASTHRU              TT_PHYDEVNAM            TT_PRINTER
    TT_READSYNC             TT_REGIS                TT_REMOTE
    TT_SCOPE                TT_SECURE               TT_SETSPEED
    TT_SIXEL                TT_SYSPWD               TT_TTSYNC
    TT_WRAP                 UNIT                    VOLCOUNT
    VOLNAM                  VOLNUMBER               VOLSETMEM
    VPROT                   WWID                    WCK

    * Alpha only

  3 - Examples

    1.$ ERR = F$GETDVI("_DQA0","ERRCNT")
      $ SHOW SYMBOL ERR
        ERR = 0  Hex = 00000000 Octal = 000000

      This example shows how to use the F$GETDVI function to return
      an error count for the device DQA0. You must place quotation
      marks (" ")  around the device name DQA0 and the item ERRCNT
      because they are string literals.

    2.$ LIBRARY/EXTRACT=$DCDEF/OUTPUT=$DCDEF.TXT SYS$LIBRARY:STARLET.MLB

      This example shows how to create a file, $DCDEF.TXT, containing
      a list of values for device types and device classes from
      the STARLET library. The device classes begin with 'DC$', and
      device types begin with 'DT$'.

      Note that most modern SCSI disks and tapes return the generic
      DEVTYPE code (DT$_GENERIC_DK or DT$_GENERIC_MK), therefore you
      should use the DEVICE_TYPE_NAME item:

        $ X=F$GETDVI("XDELTA$DKA0:","DEVICE_TYPE_NAME")
        $ SHOW SYMBOL X
          X = "RZ29B"
  Close     Help