Symantec PCANYWHERE - V12.5 User manual

OLE Automation Guide

OLE Automation Guide
Legal Notice
Copyright © 2008 Symantec Corporation. All rights reserved.
Symantec, the Symantec Logoare trademarks or registered trademarks of Symantec
Corporation or its affiliates in the U.S. and other countries. Other names may be trademarks
of their respective owners.
This Symantec product may contain third party software for which Symantec is required
to provide attribution to the third party (“Third Party Programs”). Some of the Third Party
Programs are available under open source or free software licenses. The License Agreement
accompanying the Software does not alter any rights or obligations you may have under
those open source or free software licenses. Please see the Third Party Legal Notice Appendix
to this Documentation or TPIP ReadMe File accompanying this Symantec product for more
information on the Third Party Programs.
The product described in this document is distributed under licenses restricting its use,
copying, distribution, and decompilation/reverse engineering. No part of this document
may be reproduced in any form by any means without prior written authorization of
Symantec Corporation and its licensors, if any.
THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS,
REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,
ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO
BE LEGALLY INVALID. SYMANTEC CORPORATION SHALL NOT BE LIABLE FOR INCIDENTAL
OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING,
PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINED
IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights in
Commercial Computer Software or Commercial Computer Software Documentation", as
applicable, and any successor regulations. Any use, modification, reproduction release,
performance, display or disclosure of the Licensed Software and Documentation by the U.S.
Government shall be solely in accordance with the terms of this Agreement.

Symantec Corporation
20330 Stevens Creek Blvd.
Cupertino, CA 95014
http://www.symantec.com
Printed in the United States of America.
10987654321

Technical Support
Symantec Technical Support maintains support centers globally. Technical
Support’s primary role is to respond to specific queries about product features
and functionality. The Technical Support group also creates content for our online
Knowledge Base. The Technical Support group works collaboratively with the
other functional areas within Symantec to answer your questions in a timely
fashion. For example, the Technical Support group works with Product Engineering
and Symantec Security Response to provide alerting services and virus definition
updates.
Symantec’s maintenance offerings include the following:
■A range of support options that give you the flexibility to select the right
amount of service for any size organization
■Telephone and Web-based support that provides rapid response and
up-to-the-minute information
■Upgrade assurance that delivers automatic software upgrade protection
■Global support that is available 24 hours a day, 7 days a week
■Advanced features, including Account Management Services
For information about Symantec’s Maintenance Programs, you can visit our Web
site at the following URL:
www.symantec.com/techsupp/
Contacting Technical Support
Customers with a current maintenance agreement may access Technical Support
information at the following URL:
www.symantec.com/techsupp/
Before contacting Technical Support, make sure you have satisfied the system
requirements that are listed in your product documentation. Also, you should be
at the computer on which the problem occurred, in case it is necessary to replicate
the problem.
When you contact Technical Support, please have the following information
available:
■Product release level
■Hardware information
■Available memory, disk space, and NIC information
■Operating system

■Version and patch level
■Network topology
■Router, gateway, and IP address information
■Problem description:
■Error messages and log files
■Troubleshooting that was performed before contacting Symantec
■Recent software configuration changes and network changes
Licensing and registration
If your Symantec product requires registration or a license key, access our technical
support Web page at the following URL:
www.symantec.com/techsupp/
Customer service
Customer service information is available at the following URL:
www.symantec.com/techsupp/
Customer Service is available to assist with the following types of issues:
■Questions regarding product licensing or serialization
■Product registration updates, such as address or name changes
■General product information (features, language availability, local dealers)
■Latest information about product updates and upgrades
■Information about upgrade assurance and maintenance contracts
■Information about the Symantec Buying Programs
■Advice about Symantec's technical support options
■Nontechnical presales questions
■Issues that are related to CD-ROMs or manuals

Maintenance agreement resources
If you want to contact Symantec regarding an existing maintenance agreement,
please contact the maintenance agreement administration team for your region
as follows:
[email protected]Asia-Pacific and Japan
[email protected]Europe, Middle-East, and Africa
[email protected]North America and Latin America
Additional enterprise services
Symantec offers a comprehensive set of services that allow you to maximize your
investment in Symantec products and to develop your knowledge, expertise, and
global insight, which enable you to manage your business risks proactively.
Enterprise services that are available include the following:
These solutions provide early warning of cyber attacks, comprehensive threat
analysis, and countermeasures to prevent attacks before they occur.
Symantec Early Warning Solutions
These services remove the burden of managing and monitoring security devices
and events, ensuring rapid response to real threats.
Managed Security Services
Symantec Consulting Services provide on-site technical expertise from
Symantec and its trusted partners. Symantec Consulting Services offer a variety
of prepackaged and customizable options that include assessment, design,
implementation, monitoring, and management capabilities. Each is focused on
establishing and maintaining the integrity and availability of your IT resources.
Consulting Services
Educational Services provide a full array of technical training, security
education, security certification, and awareness communication programs.
Educational Services
To access more information about Enterprise services, please visit our Web site
at the following URL:
www.symantec.com
Select your country or language from the site index.

Technical Support ............................................................................................... 4
Chapter 1 Using OLE Automation with Symantec
pcAnywhere ...................................................................... 9
About OLE Automation ................................................................... 9
About the pcAnywhere Automation Server ....................................... 10
What you can do with the pcAnywhere Automation Server .................. 10
Before you start ........................................................................... 11
Automatically registering the remote engine ............................... 11
Manually registering the remote engine ..................................... 11
Accessing the pcAnywhere Automation Server ............................ 12
Accessing the pcAnywhere Automation Server with Visual
Basic .............................................................................. 12
Accessing the pcAnywhere Automation Server with Visual
C++ ............................................................................... 13
Launching host and remote OLE objects ..................................... 15
Where to find more information ..................................................... 15
Chapter 2 Visual Basic object definitions ......................................... 17
About Visual Basic objects ............................................................. 17
CRemoteDataManager methods ...................................................... 18
CRemoteData properties ................................................................ 21
Connection type properties ...................................................... 23
Dialing properties .................................................................. 25
COM device properties ............................................................ 26
NetBIOS device properties ....................................................... 29
ISDN via CAPI 2.0 device properties ........................................... 30
CRemoteDataEx object .................................................................. 31
Visual Basic sample code for remote functionality ........................ 32
CHostDataManager methods .......................................................... 34
CHostData properties ................................................................... 36
Connection type properties ...................................................... 38
AssignConnection(ConnectionType) method ............................... 41
UnassignConnection(ConnectionType) method ............................ 41
Dialing properties .................................................................. 42
Contents

COM device properties ............................................................ 42
NetBIOS device properties ....................................................... 45
ISDN via CAPI 2.0 device properties ........................................... 46
CHostDataEx object ...................................................................... 47
Visual Basic sample code for host functionality ........................... 54
Awrem32 functions ...................................................................... 55
Chapter 3 Visual C++ object definitions ........................................... 59
About Visual C++ objects ............................................................... 59
CRemoteDataManager methods ...................................................... 60
CRemoteData object ..................................................................... 63
Get and Set methods ............................................................... 63
Remote object Detail methods .................................................. 66
Remote object methods ........................................................... 68
CRemoteDataEx object .................................................................. 70
Visual C++ sample code for remote functionality ......................... 70
CHostDataManager methods .......................................................... 71
CHostData object ......................................................................... 75
Get and Set methods ............................................................... 75
Host object Detail methods ...................................................... 76
Host object methods ............................................................... 80
CHostDataEx object ...................................................................... 82
Visual C++ sample code for host functionality ............................. 84
Awrem32 functions ...................................................................... 85
Index .................................................................................................................... 89
Contents8

Using OLE Automation with
Symantec pcAnywhere
This chapter includes the following topics:
■About OLE Automation
■About the pcAnywhere Automation Server
■What you can do with the pcAnywhere Automation Server
■Before you start
■Where to find more information
About OLE Automation
OLE Automation is a technology that lets you create an external application or
other development tool (such as a script or macro) that can control and automate
any exposed function within an application.
OLE Automation consists of the following components:
An application or software component that exposes its
functionality so that it can be accessed or controlled by
other applications or development tools
The pcAnywhere Automation Server is an example of an
OLE Automation server.
OLE Automation server
1
Chapter

An application or development tool that accesses and
controls the components that have been exposed by the
OLE Automation server
You can use any programming language that supports OLE
Automation. The two most common programming
languages are Microsoft Visual Basic and Microsoft Visual
C++.
OLE Automation controller
An external application accesses an OLE Automation server by connecting to the
server and then requesting access to one or more of its published interfaces. An
interface is an entry point that allows access to one or more related methods or
properties. After an application obtains an interface to the server, it can then call
any internal interface method as though it were part of the external application.
About the pcAnywhere Automation Server
The pcAnywhere Automation Server lets external applications manage
pcAnywhere remote and host files to automate remote control and file transfer
tasks. The pcAnywhere Automation Server functions as a programmable
replacement for the Symantec pcAnywhere user interface and mirrors much of
its default behavior.
For example, when you create a host object in pcAnywhere, the first available
modem TAPI device is assigned by default. Similarly, when you create a host object
using the pcAnywhere Automation Server and then enumerate through the list
of assigned connections, the first available modem TAPI device is already assigned.
What you can do with the pcAnywhere Automation
Server
The pcAnywhere Automation Server lets you automate a variety of administrative
and productivity tasks.
You can use the pcAnywhere Automation Server to do the following:
■Automatically distribute and install software updates on multiple computers
across your network
■Schedule automatic file transfers between computers for audit or archive
purposes
■Automatically add a name to or remove a name from the allowed callers list
on every pcAnywhere host on your network
Using OLE Automation with Symantec pcAnywhere
About the pcAnywhere Automation Server
10