SharedPropertyGroup interface  Chapter 4: ActiveX Client Interfaces

Chapter 3: ActiveX IDispatch Interface Reference

SharedPropertyGroupManager interface

Description

Type Library

JAGSHAREDPROPLib

ProgID

Jaguar.SharedPropertyGroupManager

Contains methods to create, access, and destroy shared property groups.

Methods

Usage

The SharedPropertyGroupManager interface allows you to create new shared property groups and find out about existing groups.

See also

SharedProperty interface, SharedPropertyGroup interface




SharedPropertyGroupManager.CreatePropertyGroup

Description

Creates a new property group or retrieve a reference to the existing group with the specified name.

Syntax

Dim propgroup as JAGSHAREDPROPLib.SharedPropertyGroup

propgroup = SharedPropertyGroupManager.CreatePropertyGroup(
        ByVal groupName as String,
        isololationMode as Integer,
        releaseMode as Integer,
        alreadyExisted as Boolean)

Parameters

propGroup

A variable to receive the SharedPropertyGroup interface pointer for the new or existing property group. Set to NULL if an error occurs.

groupName

A string initialized to the name by which the property group is referred. A zero-length string is a valid name.

isolationMode

An Integer variable passed by reference. Specifies the isolation mode, which determines how properties within the group are accessed. The input value must be the following symbolic constant:

Isolation mode

Value

Meaning

LockMethod

1

The property group is locked from the first access until the current method returns. Use this isolation mode to prevent other component instances from accessing a property group while you retrieve or set multiple properties in the group.

If the property group already exists, the input value is ignored and the output value is set to reflect the isolation mode of the existing property group.

releaseMode

An Integer variable passed by reference. The variable describes the release mode for the property group. On input, must be the following symbolic constant:

Release mode

Value

Meaning

Process

1

The property group is not destroyed even when all references have been released.

If the property group already exists, the input value is ignored and output value is set to reflect the release mode of the existing property group.

alreadyExisted

A Boolean variable passed by reference. On output, set to TRUE if the property group already existed or FALSE otherwise.

Usage

CreatePropertyGroup creates a new shared property group or returns a reference to an existing group that has the specified name.

Property groups can be shared only among components that are installed in the same EAServer package. A group created by a component that is installed in one package can not be retrieved by a component that is installed in a different package.

See also

Group, SharedPropertyGroup interface




SharedPropertyGroupManager.Group

Description

Retrieves a reference to an existing property group.

Syntax

Dim propgroup as JAGSHAREDPROPLib.SharedPropertyGroup

propgroup = SharedPropertyGroupManager.Group(
        ByVal groupName as String)

Parameters

propGroup

A variable to receive the SharedPropertyGroup interface pointer for the property group. Set to NULL if an error occurs.

groupName

The name of the group to be retrieved. A zero-length string is a valid name.

Usage

Group returns a reference to the property group with the same name. Group fails if no group has been created with the specified name. Call CreatePropertyGroup when you are not sure whether a group already exists.

Property groups can be shared only among components that are installed in the same EAServer package. A group created by a component that is installed in one package can not be retrieved by a component that is installed in a different package.

See also

CreatePropertyGroup, SharedPropertyGroup interface





Copyright © 2005. Sybase Inc. All rights reserved. Chapter 4: ActiveX Client Interfaces