Omron CX-SUPERVISOR 3.1 NET INTERFACE REFERENCE

Cat No. W15E-EN-01

Software

CX-Supervisor

Software Release 3.1

.NET Interface

Reference

Trademarks and copyrights Notice

Notice

OMRON products are manufactured for use by a trained operator and only for
the purposes described in this manual.

The following conventions are used to classify and explain the precautions in
this manual. Always heed the information provided with them.

Note: Indicates information of particular interest for efficient and convenient

operation of the product.

Caution:

Indicates information that, if not heeded, could possibly result in minor or
relatively serious injury, damage to the product, or faulty operation.

Warning:

Indicates information that, if not heeded, could possibly result in serious injury
or loss of life.

Trademarks and copyrights

CX-Supervisor is a registered trademark of OMRON.
All other product names, company names, logos or other designations

mentioned herein are trademarks of their respective owners.

Copyright

Copyright © 2010 OMRON
All rights reserved. No part of this publication may be reproduced, stored in a

retrieval system, or transmitted, in any form, or by any means, mechanical,
electronic, photocopying, recording, or otherwise, without the prior written
permission of OMRON.

No patent liability is assumed with respect to the use of the information
contained herein. Moreover, because OMRON is const antly striving to improve
its high-quality products, the information contained in this manual is subject to
change without notice. Every precaution has been taken in the preparation of
this manual. Nevertheless, OMRON assumes no responsibility for errors or
omissions. Neither is any liability assumed for damages resulting from the use
of the information contained in this publication.

1

Copyright Notice

2

Table of Contents

Notice................................................................................................1

Trademarks and copyrights..................................................................................................................1

Copyright..............................................................................................................................................1

SECTION 1

Introduction......................................................................................7

1-1 Who Should Read This Document ...................... .................................................... ............................7

1-2 Interface Overview ...............................................................................................................................7

1-3 Referencing the DLL ............................................................................................................................7

SECTION 2

Examples ..........................................................................................9

2-1 VB .NET ..............................................................................................................................................9

2-2 C# .NET ............. .... ............................................................................. ... .... ... ... ... .... ............................9

2-3 VB .NET and ASP.NET .......................................................................................................................9

SECTION 3

Class Reference.............................................................................11

3-1 PointMngt...........................................................................................................................................11

3-1-1 ListGroups.............................................................................................................................11

3-1-2 ListPoints ..............................................................................................................................11

3-1-3 SetValue ...............................................................................................................................11

3-1-4 GetValue...............................................................................................................................11

3-1-5 IsValidPoint... ........................................................................................................................12

3-1-6 IsValidGroup.........................................................................................................................12

3-1-7 GetPointData ........................................................................................................................12

3-1-8 BrowsePoints........................................................................................................................12

3-2 ApplicationMngt..................................................................................................................................13

3-2-1 GetErrorString.......................................................................................................................13

3-2-2 Restart ..................................................................................................................................13

3-2-3 GetProjectName ...................................................................................................................13

3-2-4 ListDevices............................................................................................................................14

3-2-5 GetDeviceStatus...................................................................................................................14

3-2-6 GetAppId...............................................................................................................................14

3-2-7 IsValidAppId..........................................................................................................................14

3-2-8 IsValidUser............................................................................................................................14

3-3 AlarmMngt..........................................................................................................................................15

3-3-1 ListAlarmGroups...................................................................................................................15

3-3-2 ListAlarms.............................................................................................................................15

3-3-3 GetAlarmData.......................................................................................................................15

3-3-4 AcknowledgeAlarm...............................................................................................................16

3-3-5 AcknowledgeAllAlarms .........................................................................................................16

3-3-6 BrowseAlarms.......................................................................................................................16

3-3-7 GetAlarmLog.........................................................................................................................16

3-3-8 GetActiveAlarms...................................................................................................................16

3

Table of Contents

3-4 ScriptMngt.......................................................................................................................................... 17

3-4-1 ExecuteScript ....................................................................................................................... 17

3-4-2 ListScripts............................................................................................................................. 17

3-4-3 GetScriptParameters............................................................................................................ 17

3-5 ErrorMngt........................................................................................................................................... 17

3-5-1 GetErrorLog.......................................................................................................................... 17

Revision history.............................................................................19

4

Table of Contents

5

Table of Contents

6