Chapter 3 ActiveX IDispatch Interface Reference
Type Library |
JAGSHAREDPROPLib |
Progid |
Jaguar.SharedPropertyGroup |
Represents a group of properties that are shared by all ActiveX components in a Jaguar package. Contains methods to create, access, and destroy shared properties.
Call the SharedPropertyGroupManager methods to create a new SharedPropertyGroup object or to obtain a reference to an existing property group.
Property groups can be shared only among components that are installed in the same Jaguar package.
SharedProperty interface, SharedPropertyGroupManager interface
Create a new shared property by name.
Dim myProp as JAGSHAREDPROPLib.SharedProperty
myProp = SharedPropertyGroup.CreateProperty (
ByVal propertyName as String,
alreadyExisted as Boolean)
myProp
A variable to receive the SharedProperty interface pointer. On return, the variable is a SharedProperty that accesses the property or NULL if an error occurred.
propertyName
Specifies the name by which the property will be referred.
alreadyExisted
A Boolean variable passed by reference. On output, set to TRUE if the group existed before the call and FALSE otherwise.
CreateProperty creates named properties that can be retrieved with the Property method. Properties can be referenced either by name or by position but not by both.
Newly created properties are set to a default value, which is a VARIANT of type VT_I4 (4-byte integer), with a value of 0.
Call CreatePropertyByPosition to create indexed properties (retrieved with PropertyByPosition).
CreatePropertyByPosition, Property, PropertyByPosition, SharedProperty interface
Create a new shared property by position.
Dim myProp as JAGSHAREDPROPLib.SharedProperty
myProp = SharedPropertyGroup.CreatePropertyByPosition(
ByVal position as Integer,
alreadyExisted as Boolean)
myProp
A variable to receive the SharedProperty interface pointer. On return, the variable is a SharedProperty that accesses the property or NULL if an error occurred.
position
The integer index by which the property will be referred.
alreadyExisted
A Boolean variable passed by reference. On output, set to TRUE if the group existed before the call and FALSE otherwise.
CreatePropertyByPosition creates indexed properties that can be retrieved with the PropertyByPosition method. Properties can be referenced either by name or by position but not by both.
Newly created properties are set to a default value, which is a VARIANT of type VT_I4 (4-byte integer), with a value of 0.
Call CreateProperty to create named properties (retrieved with Property).
CreateProperty, Property, PropertyByPosition
Retrieve a reference to a named property.
Dim myProp as JAGSHAREDPROPLib.SharedProperty
myProp = SharedPropertyGroup.CreateProperty(
ByVal name as String)
myProp
A variable to receive the SharedProperty interface pointer. On return, the variable is set to a SharedProperty that accesses the property or NULL if an error occurred.
name
Specifieds the name of the property to be retrieved.
Named properties are created with the CreateProperty method.
Property fails if the requested property has not been created. Call CreateProperty when you are not sure whether a property exists yet. CreateProperty retrieves existing properties or creates them if they do not already exist.
CreateProperty, CreatePropertyByPosition, PropertyByPosition
Retrieve a reference to an indexed property.
Dim myProp as JAGSHAREDPROPLib.SharedProperty
myProp = SharedPropertyGroup.PropertyByPosition(
ByVal position as Integer)
myProp
A variable to receive the SharedProperty interface pointer. Set to a SharedProperty that accesses the property or NULL if an error occurred.
position
The index of the property to be retrieved.
Indexed properties are created with the CreatePropertyByPosition method.
PropertyByPosition fails if the requested property has not been created. Call CreatePropertyByPosition when you are not sure whether a property exists yet. CreatePropertyByPosition retrieves existing properties or creates them if they do not already exist.
CreateProperty, CreatePropertyByPosition, Property
| Copyright © 2000 Sybase, Inc. All rights reserved. |
| |