RemoteWare ActiveX Controls Reference Manual - help.sap.com

RemoteWareActiveX Controls

R e f e r e n c e M a n u a l

V e r s i o n 4 . 1 S e r v i c e P a c k 1 A

RemoteWare ActiveX Controls Reference ManualVersion 4.1 Service Pack 1A

This document was prepared to assist licensed users of RemoteWare by XcelleNet, Inc.; its contents may not be used for any other purpose without prior written permission. The material contained herein is supplied without representation or warranty of any kind and is based on typical use. Any unusual use may produce unpredictable results. XCELLENET ASSUMES NO RESPONSIBILITY AND SHALL HAVE NO LIABILITY OF ANY KIND ARISING FROM THE SUPPLY OR USE OF THIS DOCUMENT OR THE MATERIAL CONTAINED HEREIN. Companies, names, information, and data used in examples herein are fictitious unless otherwise noted. The information in this document is furnished for informational use only and is subject to change without notice.

References in this manual to XcelleNet products, programs, or services do not imply that XcelleNet intends to make these available in all countries in which XcelleNet operates.

Restricted Rights: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in FAR 52.227-19.

© 1997-2003 XcelleNet, Inc. All Rights Reserved.

All rights reserved, including the right to reproduce this document or any portion thereof in any form.

Printed in the United States of America.

RemoteWare is a trademark of XcelleNet, Inc.

Other product and company names mentioned herein may be the brand names, trade names, trademarks or registered trade-marks of their respective orders.

Contents

USING THIS GUIDE

About this guide ................................................................................................................. vUse Adobe Acrobat to view guide online .......................................................................... vUsing RemoteWare online Help ...................................................................................... vi

RemoteWare Support Services........................................................................................ vii

What’s in this guide ......................................................................................................... viii

Related publications.......................................................................................................... ix

CHAPTER 1: INTRODUCING THE CONTROLS

About the Controls ...................................................................................................... 12

Variable Type Notations............................................................................................... 13

CHAPTER 2: REMOTEWARE CLIENT CONTROL

Using RemoteWare Client Control ................................................................................. 16

RemoteWare Client Control Properties ..................................................................... 16

RemoteWare Client Control Events ............................................................................... 21

RemoteWare Client Control Methods........................................................................ 22

CHAPTER 3: REMOTEWARE DIRECTORY CONTROL

Using RemoteWare Directory Control ........................................................................... 26

RemoteWare Directory Control Properties ............................................................... 26

RemoteWare Directory Control Events ......................................................................... 28

RemoteWare Directory Control Methods ...................................................................... 28

CHAPTER 4: REMOTEWARE LOG CONTROL

Using RemoteWare Log Control.................................................................................... 34

RemoteWare Log Control Properties ......................................................................... 34

RemoteWare Log Control Events............................................................................... 35

RemoteWare Log Control Methods ........................................................................... 35

CHAPTER 5: REMOTEWARE ACTIVEX CONTROLS

About the Controls........................................................................................................... 38

iv R e m o t e W a r e A c t i v e X C o n t r o l s R e f e r e n c e M a n u a l

Using RemoteWare Client Interface Control ................................................................. 39

Adding RemoteWare Client Interface Control to a Web page ...................................... 40

Using the Control in a Browser................................................................................... 41

Chapter X: Chapter Title <-- Apply “chapter hidden” style

Using This GuideThis guide introduces you to RemoteWare, a remote systems management tool specifically designed to distribute software and perform inventory scans for remote and fixed-site users. It contains conceptual overviews to help you use the software.

About this guide

We recommend you print this guide so it is readily available as you perform your tasks. If you prefer to use this guide online, you may find it helpful to zoom to 150% for enhanced readability.

Printing this manual

From Acrobat Reader, you can print the entire guide or a range of pages.

To print the guide:

1 On the File menu, click Print.

2 Select the printer and number of copies, and click OK.

Use Adobe Acrobat to view guide online

Use Adobe Acrobat Reader’s hyperlinks and Find features to easily access information in this guide.

Hyperlinks

Hyperlinks take you directly to a topic or page. Hyperlinks are included for the following:

• Table of Contents and Index

• Topics at the beginning of each chapter

vi R e m o t e Wa re A c t i v e X Co n t r o l s R e f e r en c e M an ua l

• Cross references

To use hyperlinks:

1 Click the Hand tool on the Acrobat Reader toolbar. The pointer changes to a

hand.

2 Place the hand symbol over the topic/page number you want to view and click. Acrobat Reader takes you to the page you selected.

Find feature

You can use Find to search for text in any document you have open.

To search for text:

1 On the toolbar, click Find.

2 Enter the term(s) you want to find in the Find What field. Click Cancel to close.

3 To narrow your search:

• Match Whole Word Only to search for the exact term only.

• Match Case to do a case-sensitive search.

• Find Backwards to move backwards instead of forwards through the document.

4 Click Find to begin your search.

To continue to search for other instances of a term, select Edit and Find Again. In the Find dialog box, the original term displays in the Find What field. Click Find Again. Repeat this process until you have found the section you want to view.

Using RemoteWare online Help

RemoteWare online Help provides explanations of features and steps for how to complete tasks.

To access RemoteWare online Help:

On the application’s Help menu, click Topics (or Help Topics), or press F1.

Us i ng Th i s G u i d e v i i

RemoteWare Support Services

XcelleNet offers a variety of support options to help you get the most out of RemoteWare.

If you have a question about the product, first look in the documentation or consult the online Help. If you can’t find the answer, contact Customer Support.

Customers who are on a maintenance plan with XcelleNet may contact Technical Support Monday through Friday from 8:30 A.M. to 8:30 P.M. EST for assistance. Call the Technical Support staff at 1-800-669-1211 toll free, 678-585-7320 in the Atlanta, Georgia area or +44 208 538 5888 for Europe, Middle East or Africa. You can find detailed information on obtaining Technical Support on XcelleNet’s www.XcelleNet.com web site.

http://www.xcellenet.com

viii R e mo t eWar e A c t i v eX C o n t r o l s R e f e r e nc e M a nu a l

What’s in this guide

This guide includes the following:

Table 1. Chapters in this guide

Chapter Title Description

Chapter 1 Introducing the Controls Briefly describes the different controls. Also describes the variable type notations used in this manual.

Chapter 2 RemoteWare Client Control Describes the RemoteWare Client Control in detail, including all properties, events, and methods.

Chapter 3 RemoteWare Directory Control Describes the RemoteWare Directory Control in detail, including all properties, events, and methods.

Chapter 4 RemoteWare Log Control Describes the RemoteWare Log Control in detail, including all properties, events, and methods.

Chapter 5 Other RemoteWare ActiveX Controls

Describes other RemoteWare ActiveX Controls in detail, including how to add each control to a Web page and how each control operates in a browser.

U s in g T h i s G u i de ix

Related publications

In addition to this manual, the following related manuals are available in printed format from your RemoteWare representative. They are also available in electronic format on the RemoteWare CD-ROM.

• RemoteWare Server Administrator’s Guide. Explains how to operate and maintain a RemoteWare system. It takes a task-oriented approach to describing features.

• RemoteWare Server Reference Guide. Contains a detailed description of every application, facility, window, menu, and control present in the RemoteWare Server. Use this book when you want to know what something does, how it is used, or why it behaves as it does.

Electronic documentation

The following documents are available on the RemoteWare CD. Unless otherwise specified, all documents reside in the \Documents directory. All electronic documents require the Adobe® Acrobat® reader to view and print PDF files. Install the reader from the RemoteWare CD using the \Acroread\ar32e301.exe file.

Administrator guides

• RemoteWare Inventory Manager Administrator’s Guide. Explains how to use Inventory Manager for centralized monitoring and reporting of hardware and software resources on RemoteWare Clients. Instructions include how to create Inventory Manager Profiles that control the operating and scheduling of Client inventory scans, and how to assign those Profiles to Clients. The guide also describes how to view and interpret the centrally stored resource information for each Client.

• RemoteWare Multicast System Administrator’s Guide. Explains how to use RemoteWare Multicast. Multicast allows administrators to distribute files to a large number of RemoteWare Clients with a single communication session from the Server. It contains fundamental information necessary to use the software, including a conceptual overview and highly interactive walkthroughs.

• RemoteWare Software Manager Administrator’s Guide. Explains how to use Software Manager to efficiently and securely distribute, install, and manage software for enterprise system users. Includes how to create and define software package contents and then assign that package to a RemoteWare Client.

• RemoteWare Subscriber Administrator’s Guide. Shows how to build and deploy lists of files and applications to the Client. It also explains how to use the Subscriber Lists at the RemoteWare Client.

x R e mo t eWa re Ac t i v e X Co n t r o l s R e f e r e n c e M a n ua l

• RemoteWare Workshop Developer’s Guide. Explains how to use RemoteWare Workshop to create and publish customized desktop-style Workshop applications.

• RemoteWare Workshop Programmer’s Guide. Describes optional programmatic extensions that enhance Workshop environments.

• Summit BasicScript Reference Manual and Summit BasicScript User’s Guide provide information on the options and structure for RemoteWare scripting. These documents are available in the \Document\Development Tool Administrator Guides\Summit BasicScript Documentation directory on the RemoteWare CD.

• User’s Guide/VirusScan for Windows 3.1®, 95, and NT. Helps the Windows Client user understand the functionality in McAfee VirusScan for Windows 3.1, Windows 95, and Windows NT Workstation 4.0.

• pcAnywhere™. Assists you in using pcAnywhere with RemoteWare Remote Control.

Client guides

• RemoteWare 32-Bit Windows Client User’s Guide. Helps the 32-bit Windows Client user install, set up, and understand the functionality in the RemoteWare Client.

• RemoteWare Windows 3.x Client User’s Guide. Helps the 16-bit Client user install, learn, and take advantage of all the features available in the RemoteWare Windows 3.x Client software.

• RemoteWare OS/2 Client User’s Guide. Presents the features, setup procedures, available options, and connection methods for the OS/2 Client software.

• RemoteWare Text-Based Clients User’s Guide. Explains how to use the UNIX, VMS, 4690 and DOS Clients to communicate with the RemoteWare Server.

• RemoteWare Software Manager Client User’s Guide. Describes how Client users can subscribe to Software Manager packages and then communicate with a RemoteWare Server to receive those packages.

C H A P T E R

1


1 Introducing the Controls

The RemoteWare 32-bit Client software includes several ActiveX controls (also called

OLE controls) that can be used to add selected Client functionality to ActiveX or OLE

container applications you develop or purchase. The controls are automatically installed

and registered with Windows 95/98/Me or NT/2000/XP when the RemoteWare 32-bit

Client software is installed.

The RemoteWare CD-ROM also includes ActiveX controls that can be used to add

selected RemoteWare functionality to Web pages. The ActiveX controls are not

automatically installed with other RemoteWare software, so if you need the ActiveX

controls, you must first install and register them, as explained in Chapter 5,

"RemoteWare ActiveX Controls."

This chapter includes:

• Brief description of the controls

• Descriptions of variable type identifiers

12 R e m o t e Wa re A c t i v e X Co n t r o l s R e f e r en c e M an ua l

About the Controls

The RemoteWare OLE controls are as follows:

• RemoteWare Client Control. This control provides methods, properties, and events that allow initiation, monitoring, and control of 32-bit Client connections. This control is described in Chapter 2, "RemoteWare Client Control."

• RemoteWare Directory Control. This control provides methods, properties, and events to display and control a Directory folder window for a Client. This control is described in Chapter 3, "RemoteWare Directory Control."

• RemoteWare Log Control. This control provides methods, properties, and events to query the contents of a Client's log file. This control is described in Chapter 4, "RemoteWare Log Control."

• Other RemoteWare ActiveX controls. RemoteWare version 3.3 includes other ActiveX controls that can be used in Web pages. Chapter 5, "Other RemoteWare ActiveX Controls," describes those controls and discusses how to include them in a Web page.

Important: Additional 32-Bit Client interface functions are provided through RemoteWare 32-bit Client API functions, which are described in the RemoteWare API Reference Manual.

CH A PT E R 1 / I n t ro du c in g t he Co n t r o l s 13

Variable Type Notations

OLE controls can be dropped into a number of environments, each having different notations for different variable types. Therefore, this manual uses the “generic” notations shown below:

Table 1. Variable Type Notations

Notation Description

BOOL Boolean type equal to True or False. Equivalent to Visual Basic’s BOOLEAN type.

I2 Two byte integer type. Equivalent to Visual Basic’s INTEGER type.

I4Four byte integer type. Equivalent to Visual Basic’s LONG type.

BSTRSpecial string type used with OLE controls.Can be assigned to or from Visual Basic’s STRING type.

Note: Special care should taken if using Visual Basic's Variant data type. See your Visual Basic documentation for details.

C H A P T E R

2


1 RemoteWare Client Control

The RemoteWare Client Control provides methods, properties, and events that enable

initiation, monitoring, and control of 32-bit Client connections.


• General guidelines for using the control

• Client control properties

• Client control events

• Client control methods


� Using RemoteWare Client Control

The RemoteWare Client Control's methods, properties, and events are provided through the RWCCLNT.OCX file, which is automatically installed and registered when the 32-bit Client software is installed.

After a RemoteWare Client Control is added to an ActiveX container application, OLE automation can be used with the control's methods, properties, and events to initiate, monitor, and control 32-bit Client connections.

Bind Control to a client First

To use an instance of the RemoteWare Client Control, the control's ClientName property must first be assigned a valid RemoteWare Client Name, either at runtime or design time.

The ClientName property binds the control instance to a particular Client software installation on the system. That particular Client's configuration and operating files are subsequently accessed by the control instance's methods and properties, and only events for that Client cause event triggers for the control instance.

RemoteWare Client Control Properties

ClientName

Assign a valid RemoteWare Client Name to this property. The named Client must be installed on the current system at runtime.

IMPORTANT: This property must be assigned before any methods or events or any other properties become useable.

AlertText

This contains substrings (separated by commas) that describe the current status of the selected Client. Possible values include: "NoAutoAnswer", "ESDAvailable", "ESDDisabled", "ResourceError", "ClientNotification", and "REMOVED".

Refer to the AlertChange event for additional information, see “RemoteWare Client

Note: The RemoteWare Client Control is only useful on a system that has the RemoteWare 32-bit Client software version 3.2 or higher installed.

Note: The ClientName property is needed because a system can have multiple copies of Client installed, each with its own corresponding files and connections.

Type: BSTR Mode: Read/Write

Type: BSTR Mode: Read only

C H AP TE R 2 / R e m o t e Wa re C l i en t C o n t r o l 17

Control Events” on page 21.

CurrentCommand

If a transfer operation is currently occurring between the Client and connected Server, this contains substrings (separated by commas) that describe the type of operation occurring. The possible values are "Sending", "Receiving", "SWO", and "Unknown!".

Refer to the CommandChange event for additional information, see “RemoteWare Client Control Events” on page 21.

CurrentFileName

If a file is currently being transferred to or from the selected Client, this is the file name. It is equivalent to the Item entry in a Client's Status folder window.

CurrentFileSize

If a file is currently being transferred to or from the selected Client, this is the file size (in bytes). It is equivalent to the Size entry in a Client's Status folder window.

CurrentServerID

If the selected Client is connected with a RemoteWare Server, this is the Server's ID.

CurrentServerName

If the selected Client is connected with a RemoteWare Server, this is the Server's name.

CurrentSWO

If a Server Work Object (SWO) is currently being processed for the Client, this is the name of that work object.

FileBytesTransferred

If connected, this is the total number of bytes transferred for the currently transferring



Type: I4 Mode: Read only






item.

Refer to the BytesTransferredUpdate event for additional information, see “RemoteWare Client Control Events” on page 21.

StatusText

This contains substrings (separated by commas) that describe the current status of the selected Client. Possible values include: "AutoAnswer", "Loaded", "Dialing", "Connecting", "Password", "Connect", "Disconnect", "ESDDisable", "PortReleased", "Ready", "NOT LOADED", and "None".

Refer to the StatusChange event for additional information, see “RemoteWare Client Control Events” on page 21.

VerboseStatusText

This is the longer version of the current status of the selected Client that includes more information (for example, the address to which the Client is connecting). It is equivalent to the Status message that appears in the status bar of a Client's Status folder window.

Refer to the StatusChange event for additional information, see “RemoteWare Client Control Events” on page 21.

SessionStartTime

If connected, this is the date and time that the connection began.

INQCurrent

If a message is currently being transferred to the selected Client's incoming message queue, this is the number of that message.

INQCurrentBytesTransferred

If a message is currently being transferred to the selected Client's incoming message queue, this is the number of bytes in that message that have been transferred so far.



Type: DATE Mode: Read only




INQCurrentPriority

If a message is currently being transferred to the selected Client's incoming message queue, this is the priority of that message.

INQCurrentTotalSize

If a message is currently being transferred to the selected Client's incoming message queue, this is the total size of that message.

INQCurrentTransferTime

Not yet supported.

INQTotalBytes

This is the total number of bytes that have been sent from the Server in this session.

INQTotalMessages

This is the total number of messages that are scheduled to be sent from the Server in this session.

INQTotalMapiMessages

This is the total number of mail messages that have been transferred into the Client’s INQ.

OUTQTotalMailMessages

This is the total number of mail messages that have been transferred from the Client's INQ.

OUTQCurrent

If a message is currently being transferred to the Server, this is the number of that message.









OUTQCurrentBytesTransferred

If a message is currently being transferred to the Server, this is number of bytes in that message that have been transferred so far.

OUTQCurrentPriority

If a message is currently being transferred to the Server, this is the priority of that message.

OUTQCurrentTotalSize

If a message is currently being transferred to Server, this is the total size of that message.

OUTQCurrentTransferTime

Not yet supported.

OUTQTotalBytes

This is the total number of bytes that have been sent from the Client in this session.

OUTQTotalMessages

This is the total number of messages that are scheduled to be sent from the Client in this session.

MaximumActivePipes

This is the maximum number of open transaction pipes that can exist for a Client Control at one time.








� RemoteWare Client Control Events

AlertChange(pszAlert, pszInfoText)

This is triggered when an alert is generated for the selected Client. The event passes the one-word alert description in pszAlert; possible values are "NoAutoAnswer", "ESDDisabled", "ResourceError", and "ESDAvailable". If pszAlert is "ESDAvailable", then pszInfoText will contain a list of the directories that received ESD (with each directory separated by a dash, for example "WINESD-UPDATES"). For all other pszAlert values, pszInfoText will be empty.

Refer to the AlertText property, which stores the pszAlert value, for additional information, see “RemoteWare Client Control Properties” on page 16.

BytesTransferredUpdate()

This is triggered whenever the total number of bytes transferred during the current connection is updated.

Refer to the FileBytesTransferred property for additonal information, see “RemoteWare Client Control Properties” on page 16.

CommandChange()

This is triggered if a change occurs in the type of operation occurring between the Client and a connected Server.

Refer to the CurrentCommand property for additonal information, see “RemoteWare Client Control Properties” on page 16.

MessageQueueChange()

This is triggered if a change occurs in the incoming or outgoing message queue.

PipeChange(sIndex, pszName)

This is triggered if a change occurs in a RemoteWare Transaction Pipe. The event passes the affected pipe's index value in sIndex and the pipe's name in pszName.

Refer to the various GetPipe... methods for additional information, see “RemoteWare Client Control Properties” on page 16.

StatusChange()

This is triggered if the selected Client's status changes (for example, from "Idle" to "Connecting").

Refer to the StatusText and VerboseStatusText properties for additional information, see “RemoteWare Client Control Properties” on page 16.


RemoteWare Client Control Methods

Connect (BSTR pszEntryName)

This causes the selected Client to connect using the directory entry specified (by name) in the pszEntryName argument. However, that argument has not yet been implemented, so the current Default directory entry is always used. The communication kernel must be loaded (see Load below).

Return value

BOOL

True if the connection succeeded, False if the connection failed.

Initialize ()

This establishes a link with the selected Client to monitor activity (it is automatically called on Client load). To use this method, the communication kernel must be loaded (see Load below), and Initialize will claim the specified port if it has been released.

Return value

BOOL

True if successful, False if not successful.

Release ()

This releases the port for the selected Client (opposite of Initialize).

Return value

BOOL


Load ()

This loads the communication kernel for the selected Client.

Return value

BOOL


Note: Additional 32-Bit Client interface functions are provided through RemoteWare 32-bit Client API functions, which are described in the RemoteWare API Reference Manual.


Unload ()

This unloads the communication kernel for the selected Client.

Return value

BOOL


Cancel (BOOL bForce)

This cancels the current connection (or connection request). If bForce is True, the cancel will be attempted even if an active connection exists. If bForce is False, the cancel will be attempted only if a connection request is pending but is not yet established; it will not be attempted if the connection is already active.

Return value

BOOL


GetLastSessionEndTime ()

This returns the date and time that the last session ended for the selected Client.

Return value

DATE

Date and time of the last session for the selected Client.

AboutBox ()

Displays the RemoteWare Client Control's About Box dialog.

Return value

VOID

GetPipeName (I2 sIndex)

This returns the name (in UNC format) of the Transaction Pipe with the specified pipe index. The index is passed by the PipeChange event.

Return value

BSTR

Name of the specified pipe. Will be empty if an invalid index was specified.

GetPipeOwner (I2 sIndex)

This returns the name of the Client system executable that owns the Transaction Pipe with the specified pipe index. The index is passed by the PipeChange event.


Return value

BSTR

Name of the executable. Will be empty if an invalid index was specified.

GetPipeDuration (I2 sIndex)

This returns the amount of time (in milliseconds) that the Transaction Pipe with the specified pipe index has been open. The index is passed by the PipeChange event.

Return value

I4

Time that the specified pipe has existed (in 1000ths of a second).

GetPipeOptions (I2 sIndex)

Not yet implemented.

GetPipeState (I2 sIndex)


GetPipeBytesRead (I2 sIndex)


GetPipeBytesReceived (I2 sIndex)


GetPipeBytesWritten (I2 sIndex)


GetPipeBytesSent (I2 sIndex)


C H A P T E R

3


1 RemoteWare Directory Control

The RemoteWare Directory Control provides methods, properties, and events to

display and control the Directory folder window for a Client. This window can include

the ability to connect using a specified Directory Entry.



• Directory control properties

• Directory control events

• Directory control methods


� Using RemoteWare Directory Control

The RemoteWare Directory Control's methods, properties, and events are provided through the RWCDRCTY.OCX file, which is automatically installed and registered when the 32-bit Client software is installed.

After a RemoteWare Directory Control is added to an OLE container application, OLE automation can be used with the control's methods, properties, and events to initiate, monitor, and control 32-bit Client connections.

Bind the Control to a Client First

To use an instance of the RemoteWare Directory Control, the control's ClientName property must first be assigned a valid RemoteWare Client Name, either at runtime or design time.



RemoteWare Directory Control Properties

ClientName


AllowConnection

True activates the Connect button in the dialog that displays when a user double-clicks a directory entry. False disables that button, preventing a user form connecting via the Directory folder window.

Note: The RemoteWare Directory Control is only useful on a system that has the RemoteWare 32-bit Client software version 3.2 or higher installed.


Important: This property must be assigned before any methods or events or any other properties become useable.

Type: BOOL Mode: Read/Write

C H A PT ER 3 / R e m o t e Wa re D i r e c t o r y C o n t r o l 27

DefaultEntryName

This contains the name of the Default Directory Entry for the selected Client.

DefaultEntryResource

This contains the type of resource used by the Default Directory Entry for the selected Client.

TotalEntries

This is the number of entries contained in the selected Client's Directory folder (excluding the Add New Entry item).

View

This indicates/sets the view type used in the Directory folder window, as follows:




Type: I2 Mode: Read/Write

0 Large icon view

1 List view

2 Horizontal small icon view

3 Vertical small icon view


� RemoteWare Directory Control Events

DirectoryModified()

This is triggered if the Directory for the selected Client is modified.

DefaultChanged()

This is triggered if the Default Directory Entry for the selected Client is changed.

Connect(lpszEntryName)

This is triggered if a user connects using the Directory folder window. The event passes the name of the Directory Entry used to make the connection in lpszEntryName.

See also the AllowConnection property.

BeginEntryNameEdit()

This is triggered when a user invokes the Directory Entry edit dialog for an entry.

EndEntryNameEdit()

This is triggered when a user closes the Directory Entry edit dialog for an entry.

� RemoteWare Directory Control Methods

EditEntry (BSTR lpszEntryName)

This invokes the Edit Entry dialog for the directory entry specified (by name) in the lpszEntryName argument.

Return value

I4

Valid return values include::

RemoveEntry (BSTR lpszEntryName)

This removes the directory entry specified (by name) in the lpszEntryName argument.

Return value

BOOL

True if successful, False if not successful (probably because an invalid entry name was passed).

1 Dialog ended with OK button

2 Dialog ended with Cancel button (or Escape), or error occurred; most likely an invalid entry name was passed


RenameEntry (BSTR lpszCurrentName, BSTR lpszNewName)

This renames the directory entry currently having the name specified in the lpszCurrentName to the new name specified in lpszNewName.

Return value

BOOL

True if successful, False if not successful (probably because an invalid current entry name was passed).

AddEntry (BSTR lpszEntryName)

This adds a directory entry with the name specified in the lpszEntryName argument. This will automatically update the TotalEntries property.

Return value

I4

Index to the new entry (which is 0 relative; that is, the first entry has an index of 0).

GetEntryNameFromIndex (I4 IEntryIndex)

This returns the name of the directory entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0). Among other things, this is useful in building an array of entry names using a loop from 1 to the value in the TotalEntries property.

Return value

BSTR

Name of the entry at the specified index. Will be empty if an invalid index was passed.

GetEntryResourceFromIndex (I4 IEntryIndex)

This returns the type of communication resource defined for the directory entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0). Among other things, this is useful in building an array of entry resources using a loop from 1 to the value in the TotalEntries property.

Return value

BSTR

Name of the entry at the specified index. Will be empty if an invalid index was passed.

IsEntryDirectConnectFromIndex (I4 IEntryIndex)

This indicates whether the resource directory entry specified (by index) in the IEntryIndex argument is a direct connect type.

Return value


BOOL

True if resource is direct connect, otherwise False.

IsEntryReadOnly (BSTR lpszEntryName)

This indicates whether the directory entry specified (by name) in the lpszEntryName argument is a read-only entry that cannot be edited.

Return value

BOOL

True if entry is read-only, otherwise False.

IsItemSelected (BSTR lpszEntryName)

This indicates whether the directory entry specified (by name) in the lpszEntryName argument is currently selected in the Directory folder window.

Return value

BOOL

True if entry is selected, otherwise False.

SelectEntry (BSTR lpszEntryName)

This selects in the Directory folder window the directory entry specified (by name) in the lpszEntryName argument.

Return value

BOOL

True if successful, False if not successful (probably because an invalid entry name was passed).

GetNextSelectedItem (BSTR lpszFromThisName)

This returns the name of the directory entry that is currently selected. If an lpszFromThisName argument is passed, a selected entry is searched for only from the entry specified in lpszFromThisName to the end of the directory entry list. If no lpszFromThisName argument is passed, the current entry is always returned.

Return value

BSTR

Name of the next selected entry. Will be empty if no selected entry was found in the range from the specified starting entry to the end of the list.


ShowMakeNewEntryItem (BOOL bVisible)

If bVisible is passed as True, this shows the Make New Entry item in the Directory folder window. If bVisible is passed as False, this hides the Make New Entry item.

Return value

BOOL

True if state specified in bVisible was already set, otherwise False.

AboutBox ()

Displays the RemoteWare Client Control's About Box dialog.

Return value

VOID

RefreshList ()


C H A P T E R

4


1 RemoteWare Log Control

The RemoteWare Log Control provides methods, properties, and events to query the

contents of a Client's log file.



• Log control properties

• Log control events

• Log control methods


� Using RemoteWare Log Control

The RemoteWare Log Control's methods, properties, and events are provided through the RWCLOG.OCX file, which is automatically installed and registered when the 32-bit Client software is installed.

After a RemoteWare Log Control is added to an OLE container application, OLE automation can be used with the control's methods, properties, and events to initiate, monitor, and control 32-bit Client connections.

Bind the Control to a Client First

To use an instance of the RemoteWare Log Control, the control's ClientName property must first be assigned a valid RemoteWare Client Name, either at runtime or design time.


RemoteWare Log Control Properties

ClientName


TotalEntries

This is the number of entries contained in the selected Client's log file.

Note: The RemoteWare Log Control is only useful on a system that has the RemoteWare 32-bit Client software version 3.2 or higher installed.



Important: This property must be assigned before any methods or events or any other properties become useable.


C H A PT ER 4 / R em o t e War e L o g C o n t ro l 35

RemoteWare Log Control Events

This control has no events.

RemoteWare Log Control Methods

GetEntryDateFromIndex (I4 IEntryIndex)

This returns the date and time from the log entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0).

Return value

DATE

Date and time from the entry at the specified index. Will be empty if an invalid index was passed.

GetEntryDurationFromIndex (I4 IEntryIndex)

This returns the duration recorded in the log entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0).

Return value

I4

Duration (in seconds) from the entry at the specified index. Will be empty if an invalid index was passed.

GetEntryOriginationFromIndex (I4 IEntryIndex)

This returns the name of origination source (such as "Client") from the log entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0).

Return value

BSTR

Origination source from the entry at the specified index. Will be empty if an invalid index was passed.

GetEntryStatusFromIndex (I4 IEntryIndex)

This returns the status description (such as "Successful Session") from the log entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0).

Return value

BSTR


Status description from the entry at the specified index. Will be empty if an invalid index was passed.

GetEntryServerFromIndex (I4 IEntryIndex)

This returns the server name from the log entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0).

Return value

BSTR

Server name from the entry at the specified index. Will be empty if an invalid index was passed.

ViewEntryDetailsFromIndex (I4 IEntryIndex)

This displays the Log Item Properties window for the log entry specified by the IEntryIndex argument (which is 0 relative; that is, the first entry has an index of 0).

Return value

I4

Valid return values are:

AboutBox ()

Displays the RemoteWare Log Control's About Box dialog.

Return value

VOID

RefreshList ()

The log control actually queries a snapshot of the log file. This method refreshes that snapshot using the current "live" log contents.

0 Error occurred; most likely an invalid entry name was passed

1 Dialog ended with OK button

2 Dialog ended with Cancel button (or Escape)

C H A P T E R

5


1 RemoteWare ActiveX Controls

RemoteWare version 4.1 includes ActiveX controls that can be used in Web pages. This

chapter describes those controls and discusses how to include them in a Web page.


• Brief descriptions of the controls

• Using RemoteWare Client Interface Control

• Steps to add RWCWRAP control to Web page


� About the Controls

The RemoteWare ActiveX controls that can currently be used in a Web page include the following:

• RemoteWare Client Interface Control. This control (RWCWRAP.OCX) loads the Client communication kernel and displays a user interface very similar to the Directory folder window for a Client. With this, a user can select and edit Directory Entries and connect using the default Directory Entry or a selected Directory Entry. RWCWRAP is described in detail in this chapter.

• RemoteWare Subscriber Interface Control. This control presents a Subscriber List window that provides the basic functions to access and manipulate a RemoteWare Subscriber List. The Subscriber List OLE Control is described in detail in the RemoteWare Subscriber Administrator's Guide.

• RemoteWare Workshop Control. This control can contain and run a published Workshop application inside a Web page. The Workshop ActiveX Control is described in detail in the RemoteWare Workshop Programmer's Guide.

• Other RemoteWare Controls. Other RemoteWare controls are being adapted for use in Web pages as ActiveX controls. This growing list of controls includes a button control with built-in RemoteWare-specific methods (connecting, launching the Client software, etc.), and many others.

Important: If a Subscriber control is added to a Web page in layout mode, it must be located as the first ActiveX control appearing on the page and it must be referenced before any other ActiveX controls in the HTML document.

C H AP TE R 5 / R e m o t e Wa re A c t i v e X Co n t r o l s 39

� Using RemoteWare Client Interface Control

This section discusses the RemoteWare Client Interface Control in detail.

Installation and Registration

When you install the RemoteWare Development Kit (RDK) on your system, the files used by the RemoteWare Client Interface Control are automatically copied to your system in the ACTIVEX subdirectory under your RDK installation directory. However, before you can use the control, you must register it on your system.

To register the control, run the sample Web page included in the RDK files:

1 Locate the LOADCTRL.HTM file on your system. It is located in the ACTIVEX subdirectory under your RDK installation directory.

2 Start your ActiveX-compatible Web browser (such as Internet Explorer).

3 Load the LOADCTRL.HTM file into the browser. An outlined rectangle placeholder will appear showing the RemoteWare Client Interface Control icon.

4 After a brief delay, an Authenticode certificate appears for the RemoteWare Client Control. Click Yes to accept.

5 An additional Authenticode certificate may appear for the MFC DLLs. If so, click Yes to accept.

6 If the loading and registration process ends successfully, the rectangle placeholder changes to a bitmap. You can now experiment with the control to see how it operates or exit from your Browser.

The control is now registered on your system.

Important: You need to have the RemoteWare Client software installed on your system. If you have not done so, install that software now.


� Adding RemoteWare Client Interface Control to

a Web page

One of the following is required to insert the control:

• You must be familiar with the proper syntax for object handles in HTML documents.

Or

• The application you are using to create the HTML document must support ActiveX controls (with a tool such as Microsoft ActiveX Control Pad).

The process you follow depends on the authoring tool you are using. The steps below assume you are using ActiveX Control Pad:

1 Open the HTML document in which you want to insert the control in the ActiveX Control Pad and position in the desired location.

2 From the Edit menu, select Insert ActiveX Control.

3 Select RemoteWare ActiveX Client Control from the list.

4 Set the control's CodeBase property to the URL path of the RWCWRAP.OCX file on your Web Server (relative paths are acceptable, as are UNC paths).

5 Close the Edit ActiveX Control window.

6 Close the Property window for the RemoteWare ActiveX Client Control.

The necessary code is inserted in the HTML document. Below is a sample of the HTML generated.

<OBJECT ID = "RWCWRAP" WIDTH=600 HEIGHT=227

CLASSID="CLSID:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx">

CODEBASE="D:\RW 95\Nodesys\Rwcwrap.ocx

<PARAM NAME="Version" VALUE="65536">

<PARAM NAME="ExtentX" VALUE="15875"

<PARAM NAME="ExtentY" VALUE="5980"

<PARAM NAME="StockProps"VALUE="0"

<PARAM NAME="ClientName" VALUE="Client1"

<PARAM NAME="DefaultEntryName" VALUE="SPX - Default 1"

<\OBJECT>

<\CENTER>

Note: You can also set the ClientName and DefaultEntryName properties.

Note: If you did not set the CodeBase property as described in step 4, you will need to add that line manually.

C H AP TE R 5 / R e m o t e Wa re A c t i v e X Co n t r o l s 41

Using the Control in a Browser

When you browse a Web page containing the RemoteWare Client Interface Control, the control operates as described in the following sections.

Activating the Control the First Time

When a Web page with the RemoteWare Client Control is viewed for the first time, the necessary files are downloaded to the browsing system and registered (assuming the control is not already installed and registered in the browsing system). If the browser is set for no security this occurs automatically. If the browser is set to medium security, a validation certificate dialog appears first to allow confirmation prior to the transfer; select Yes to accept.

The Control’s Functions

Right-click the control to display a shortcut menu with the following options:

• Configure. This displays the Directory control window which allows selection and editing of Client Directory entries. Double-click an entry to invoke the Edit dialog, from which you can also choose to connect using the selected entry.

• Connect. This connects using the default Directory entry.

• Properties. This displays a Properties page with the following:

• Client Name. This is the name of the Client to use.

• Default Entry Name. This defines the default entry.

• About. This displays the About box for the control.

Note: A second certificate may appear for the MFC DLLs. If so, select Yes to accept. After downloading, the control bitmap appears and its functions become available.

Note: Move the mouse over the control to display the current Client name in the status bar.

RemoteWare ActiveX Controls Reference Manual - help.sap.com

Documents

Transcript of RemoteWare ActiveX Controls Reference Manual - help.sap.com