VISA
NI-VISA
™
Programmer Reference Manual
NI-VISA Programmer Reference Manual
April 1998 Edition
Part Number 321073C-01
Internet Support
E-mail: support@natinst.com
FTP Site: ftp.natinst.com
Web Address: http://www.natinst.com
Bulletin Board Support
BBS United States: 512 794 5422
BBS United Kingdom: 01635 551422
BBS France: 01 48 65 15 59
Fax-on-Demand Support
512 418 1111
Telephone Support (USA)
Tel: 512 795 8248
Fax: 512 794 5678
International Offices
Australia 03 9879 5166, Austria 0662 45 79 90 0, Belgium 02 757 00 20, Brazil 011 288 3336,
Canada (Ontario) 905 785 0085, Canada (Québec) 514 694 8521, Denmark 45 76 26 00, Finland 09 725 725 11,
France 01 48 14 24 24, Germany 089 741 31 30, Hong Kong 2645 3186, Israel 03 6120092, Italy 02 413091,
Japan 03 5472 2970, Korea 02 596 7456, Mexico 5 520 2635, Netherlands 0348 433466, Norway 32 84 84 00,
Singapore 2265886, Spain 91 640 0085, Sweden 08 730 49 70, Switzerland 056 200 51 51, Taiwan 02 377 1200,
United Kingdom 01635 523545
National Instruments Corporate Headquarters
6504 Bridge Point Parkway Austin, Texas 78730-5039 USA Tel: 512 794 0100
© Copyright 1996, 1998 National Instruments Corporation. All rights reserved.
Important Information
Warranty
The media on which you receive National Instruments software are warranted not to fail to execute programming
instructions, due to defects in materials and workmanship, for a period of 90 days from date of shipment, as evidenced
by receipts or other documentation. National Instruments will, at its option, repair or replace software media that do not
execute programming instructions if National Instruments receives notice of such defects during the warranty period.
National Instruments does not warrant that the operation of the software shall be uninterrupted or error free.
A Return Material Authorization (RMA) number must be obtained from the factory and clearly marked on the outside
of the package before any equipment will be accepted for warranty work. National Instruments will pay the shipping costs
of returning to the owner parts which are covered by warranty.
National Instruments believes that the information in this manual is accurate. The document has been carefully reviewed
for technical accuracy. In the event that technical or typographical errors exist, National Instruments reserves the right to
make changes to subsequent editions of this document without prior notice to holders of this edition. The reader should
consult National Instruments if errors are suspected. In no event shall National Instruments be liable for any damages
arising out of or related to this document or the information contained in it.
E
XCEPT
AS
SPECIFIED
HEREIN
, N
ATIONAL
I
NSTRUMENTS
MAKES
NO
WARRANTIES
,
EXPRESS
OR
IMPLIED
,
AND
SPECIFICALLY
DISCLAIMS
ANY
WARRANTY
OF
MERCHANTABILITY
OR
FITNESS
FOR
A
PARTICULAR
PURPOSE
. C
USTOMER
’
S
RIGHT
TO
RECOVER
DAMAGES
CAUSED
BY
FAULT
OR
NEGLIGENCE
ON
THE
PART
OF
N
ATIONAL
I
NSTRUMENTS
SHALL
BE
LIMITED
TO
THE
AMOUNT
THERETOFORE
PAID
BY
THE
CUSTOMER
. N
ATIONAL
I
NSTRUMENTS
WILL
NOT
BE
LIABLE
FOR
DAMAGES
RESULTING
FROM
LOSS
OF
DATA
,
PROFITS
,
USE
OF
PRODUCTS
,
OR
INCIDENTAL
OR
CONSEQUENTIAL
DAMAGES
,
EVEN
IF
ADVISED
OF
THE
POSSIBILITY
THEREOF
. This limitation of the liability of
National Instruments will apply regardless of the form of action, whether in contract or tort, including negligence.
Any action against National Instruments must be brought within one year after the cause of action accrues. National
Instruments shall not be liable for any delay in performance due to causes beyond its reasonable control. The warranty
provided herein does not cover damages, defects, malfunctions, or service failures caused by owner’s failure to follow
the National Instruments installation, operation, or maintenance instructions; owner’s modification of the product;
owner’s abuse, misuse, or negligent acts; and power failure or surges, fire, flood, accident, actions of third parties,
or other events outside reasonable control.
Copyright
Under the copyright laws, this publication may not be reproduced or transmitted in any form, electronic or mechanical,
including photocopying, recording, storing in an information retrieval system, or translating, in whole or in part, without
the prior written consent of National Instruments Corporation.
Trademarks
CVI
™
, LabVIEW
™
, NI-488.2
™
, NI-VISA
™
, and NI-VXI
™
are trademarks of National Instruments Corporation.
Product and company names listed are trademarks or trade names of their respective companies.
WARNING REGARDING MEDICAL AND CLINICAL USE OF NATIONAL INSTRUMENTS PRODUCTS
National Instruments products are not designed with components and testing intended to ensure a level of reliability
suitable for use in treatment and diagnosis of humans. Applications of National Instruments products involving medical
or clinical treatment can create a potential for accidental injury caused by product failure, or by errors on the part of the
user or application designer. Any use or application of National Instruments products for or involving medical or clinical
treatment must be performed by properly trained and qualified medical personnel, and all traditional medical safeguards,
equipment, and procedures that are appropriate in the particular situation to prevent serious injury or death should always
continue to be used when National Instruments products are being used. National Instruments products are NOT intended
to be a substitute for any form of established process, procedure, or equipment used to monitor or safeguard human health
and safety in medical or clinical treatment.
©
National Instruments Corporation v NI-VISA Programmer Reference Manual
Contents
About This Manual
Organization of This Manual...........................................................................................xi
Conventions Used in This Manual...................................................................................xii
How to Use This Documentation Set ..............................................................................xii
Related Documentation....................................................................................................xiii
Customer Communication...............................................................................................xiv
Chapter 1
Introduction
What You Need to Get Started ........................................................................................1-1
Overview..........................................................................................................................1-1
Chapter 2
Overview of the VISA API
VISA Access Mechanisms...............................................................................................2-1
Attributes...........................................................................................................2-1
Events ................................................................................................................2-1
Operations..........................................................................................................2-2
VISA Resource Types .....................................................................................................2-2
INSTR................................................................................................................2-2
MEMACC .........................................................................................................2-3
Description of the API .....................................................................................................2-4
Chapter 3
Attributes
VI_ATTR_ASRL_AVAIL_NUM...................................................................................3-2
VI_ATTR_ASRL_BAUD ...............................................................................................3-3
VI_ATTR_ASRL_CTS_STATE.....................................................................................3-4
VI_ATTR_ASRL_DATA_BITS.....................................................................................3-5
VI_ATTR_ASRL_DCD_STATE....................................................................................3-6
VI_ATTR_ASRL_DSR_STATE ....................................................................................3-7
VI_ATTR_ASRL_DTR_STATE ....................................................................................3-8
VI_ATTR_ASRL_END_IN ............................................................................................3-9
VI_ATTR_ASRL_END_OUT........................................................................................3-10
VI_ATTR_ASRL_FLOW_CNTRL................................................................................3-11
VI_ATTR_ASRL_PARITY............................................................................................3-13
VI_ATTR_ASRL_REPLACE_CHAR............................................................................3-14
Contents
NI-VISA Programmer Reference Manual vi
©
National Instruments Corporation
VI_ATTR_ASRL_RI_STATE........................................................................................ 3-15
VI_ATTR_ASRL_RTS_STATE .................................................................................... 3-16
VI_ATTR_ASRL_STOP_BITS...................................................................................... 3-17
VI_ATTR_ASRL_XOFF_CHAR...................................................................................3-18
VI_ATTR_ASRL_XON_CHAR .................................................................................... 3-19
VI_ATTR_BUFFER .......................................................................................................3-20
VI_ATTR_CMDR_LA ...................................................................................................3-21
VI_ATTR_DEST_ACCESS_PRIV ................................................................................ 3-22
VI_ATTR_DEST_BYTE_ORDER ................................................................................3-23
VI_ATTR_DEST_INCREMENT...................................................................................3-24
VI_ATTR_EVENT_TYPE ............................................................................................. 3-25
VI_ATTR_FDC_CHNL.................................................................................................. 3-26
VI_ATTR_FDC_GEN_SIGNAL_EN ............................................................................ 3-27
VI_ATTR_FDC_MODE................................................................................................. 3-28
VI_ATTR_FDC_USE_PAIR.......................................................................................... 3-29
VI_ATTR_GPIB_PRIMARY_ADDR............................................................................ 3-30
VI_ATTR_GPIB_READDR_EN.................................................................................... 3-31
VI_ATTR_GPIB_REN_STATE..................................................................................... 3-32
VI_ATTR_GPIB_SECONDARY_ADDR...................................................................... 3-33
VI_ATTR_GPIB_UNADDR_EN................................................................................... 3-34
VI_ATTR_IMMEDIATE_SERV ................................................................................... 3-35
VI_ATTR_INTF_INST_NAME..................................................................................... 3-36
VI_ATTR_INTF_NUM .................................................................................................. 3-37
VI_ATTR_INTF_PARENT_NUM................................................................................. 3-38
VI_ATTR_INTF_TYPE.................................................................................................. 3-39
VI_ATTR_INTR_STATUS_ID...................................................................................... 3-40
VI_ATTR_IO_PROT...................................................................................................... 3-41
VI_ATTR_JOB_ID......................................................................................................... 3-42
VI_ATTR_MAINFRAME_LA....................................................................................... 3-43
VI_ATTR_MANF_ID..................................................................................................... 3-44
VI_ATTR_MAX_QUEUE_LENGTH............................................................................ 3-45
VI_ATTR_MEM_BASE................................................................................................. 3-46
VI_ATTR_MEM_SIZE .................................................................................................. 3-47
VI_ATTR_MEM_SPACE .............................................................................................. 3-48
VI_ATTR_MODEL_CODE ........................................................................................... 3-49
VI_ATTR_OPER_NAME .............................................................................................. 3-50
VI_ATTR_RD_BUF_OPER_MODE............................................................................. 3-51
VI_ATTR_RECV_INTR_LEVEL.................................................................................. 3-52
VI_ATTR_RECV_TRIG_ID .......................................................................................... 3-53
VI_ATTR_RET_COUNT...............................................................................................3-54
VI_ATTR_RM_SESSION.............................................................................................. 3-55
VI_ATTR_RSRC_IMPL_VERSION ............................................................................. 3-56
VI_ATTR_RSRC_LOCK_STATE................................................................................. 3-57
