IDEC WindSRV - Manual (Page 44)

43
www.kepware.com
KEPServerEX5 Help
ability to set and query a Locale ID which would be in effect for the particular client/server session. That is, the actions
of one client do not affect other clients.
 GetErrorString - Returns the error string for a server specific error code. The expected behavior is that this will
include handling of Win32 errors as well (such as RPC errors).
 GetLocale ID - Returns the default Locale ID for this server/client session.
 QueryAvailableLocale IDs - Returns the available Locale IDs for this server/client session.
 SetClientName - Allows the client to optionally register a client name with the server. This is included primarily
for debugging purposes. The recommended behavior is that users set the Node name and EXE name here.
 Set LocalID - Sets the default Locale ID for this server/client session. This Locale ID will be used by the
GetErrorString method on this interface. The default value for the server should be LOCALE_SYSTEM_DEFAULT.
IOPCServer
This is the main interface to an OPC server. The OPC server is registered with the operating system as specified in the
Installation and Registration Chapter of this specification.
 AddGroup - Adds a Group to a Server. A Group is a logical container for a client to organize and manipulate data
items.
 CreateGroupEnumerator - Creates various enumerators for the groups provided by the Server.
 GetErrorString - Returns the error string for a server specific error code.
 GetGroupByName - Returns an additional interface pointer when given the name of a private group (created
earlier by the same client). Use GetPublicGroupByName to attach to public groups. This function can be used to
reconnect to a private group for which all interface pointers have been released.
 GetStatus - Returns current status information for the server.
 RemoveGroup - Deletes the Group. A group is not deleted when all the client interfaces are released, since the
server itself maintains a reference to the group. The client may still call GetGroupByName after all the interfaces
have been released. RemoveGroup() causes the server to release it's 'last' reference to the group, which results
in the group being deleted.
IConnectionPointContainer(Server)
This interface provides the access to the connection point for IOPCShutdown.
 EnumConnectionPoints - Creates an enumerator for the connection points supported between the OPC Group
and the Client. OPCServers must return an enumerator that includes IOPCShutdown. Additional vendor specific
callbacks are allowed.
 FindConnectionPoints - Finds a particular connection point between the OPC Server and the Client. OPCServers
must support IID_IOPCShutdown. Additional vendor specific callbacks are allowed.
 IConnectionPoint(Server) - Establishes a call back to the client.
 Advise - Establishes an advisory connection between the connection point and the caller's sink object.
 EnumConnections - Creates an enumerator object for iteration through the connections that exist to this
connection point.
 GetConnectionInterface - Returns the IID of the outgoing interface managed by this connection point.
 UnAdvise - Terminates an advisory connection previously established through the Advise method.
IOPCBrowse
IOPCBrowse interface provides improved methods for browsing the server address space and for obtaining the item
properties.
 GetProperties - Returns an array of OPCITEMPROPERTIES, one for each Item ID.
 Browse - Browses a single branch of the address space and returns zero or more OPCBROWSEELEMENT
structures.
IOPCBrowseServerAddressSpace
This interface provides a way for clients to browse the available data items in the server, giving the user a list of the
valid definitions for an Item ID. It allows for either flat or hierarchical address spaces and is designed to work well over
a network. It also insulates the client from the syntax of a server vendor specific Item ID.
 BrowseAccessPaths - Provides a way to browse the available AccessPaths for an Item ID.
 BrowseOPCItem IDs - Returns an IENUMString for a list of Item IDs as determined by the passed parameters.
The position from which the browse is made can be set in ChangeBrowsePosition.
 ChangeBroserPosition - Provides a way to move up, down or to in a hierarchical space.
 GetItem ID - Provides a way to assemble a fully qualified Item ID in a hierarchical space. This is required since
the browsing functions return only the components or tokens that make up an Item ID and do not return the
delimiters used to separate those tokens. Also, at each point one is browsing just the names below the current