Description
A masked read/write property reflecting the object's UserFlags.
-
Property type
-
A mcobjUserFlags enumeration.
-
Syntax
-
object.UserFlags([eMask], [bNotifySinks]) [= value]
The UserFlags Property syntax has these parts: |
| object | An expression evaluating to an object of type McObject. | | eMask | Optional. A mcobjUserFlags enumeration, as described in settings. A mask for which flag bits are to be changed or returned.
| | bNotifySinks | Optional. A Boolean value. If True, any standard notify sinks get sent a IMcObjStandardNotify.HousekeepingChanged call after the UserFlags property has been changed. If False, no notify is fired.
| | value | A mcobjUserFlags enumeration, as described in settings. |
Settings The settings for eMask are:
|
 | mcobjUserFlagsCleared | 0 |
All flags cleared
|
| mcobjUserFlagsAll | -1 |
All flags
|
| mcobjUserFlagNoAddRefInterface | 4 |
When set, objects of type mcobjTypeXOBJECT and mcobjTypeINTERFACE do NOT AddRef/Release their interface data, but instead leave this as a reponsibility of the caller.
|
| mcobjUserFlagKeepByRefVariants | 64 |
When set, objects of type mcobjTypeVARIANT will not copy the referred-to data of VT_BYREF variants. If clear (the default), then the data is copied.
|
| mcobjUserFlagAlwaysVector | 32 |
When set, scalar object values are exposed as a safe array. This flag is set or cleared automatically when the Value property is assigned. It can subsequently be set or cleared to override the default behavior.
|
| mcobjUserFlagDisableNotifies | 32768 |
When set, standard notifies are not sent to Notify Sinks attached to the object. You may set this flag temporarily when you will be doing a series of assignments to the Value property, and do not want to send a ValueChanged notify for each assignment. Rememeber to clear this flag before doing the last Value assignment or before doing a FireStandardNotifyToAllSinks.
|
| mcobjUserFlagReadOnly | 16384 |
When set, assignment to Value is illegal
|
| mcobjUserFlagSystemObject | 1024 |
When set, Name and TagNumber cannot be changed
|
| mcobjUserFlagNotifyOnGetValue | 512 |
When set, an mcobjSNCode_BeforeGetValue SpecialNotify is sent to standard notify clients before the Value property is returned. This allows a notify sink to set the object's Value only when it is requested. See McObject.Value for more discussion.
|
| mcobjUserFlagOptionBase1 | 256 |
The Value property is exposed using base indexing of 1 for array data. If not set, then 0 based array indexing is used
|
| mcobjUserFlagsCustomMask | 16711680 |
Bits 24 thru 17 are available for the caller's custom use
|
| mcobjUserFlagsSettableMask | 16762724 |
Only these bits are settable, all others are reserved. Assignments are automatically and silently masked by this value.
|
The settings for value are:
|
| mcobjUserFlagsCleared | 0 |
All flags cleared
|
| mcobjUserFlagsAll | -1 |
All flags
|
| mcobjUserFlagNoAddRefInterface | 4 |
When set, objects of type mcobjTypeXOBJECT and mcobjTypeINTERFACE do NOT AddRef/Release their interface data, but instead leave this as a reponsibility of the caller.
|
| mcobjUserFlagKeepByRefVariants | 64 |
When set, objects of type mcobjTypeVARIANT will not copy the referred-to data of VT_BYREF variants. If clear (the default), then the data is copied.
|
| mcobjUserFlagAlwaysVector | 32 |
When set, scalar object values are exposed as a safe array. This flag is set or cleared automatically when the Value property is assigned. It can subsequently be set or cleared to override the default behavior.
|
| mcobjUserFlagDisableNotifies | 32768 |
When set, standard notifies are not sent to Notify Sinks attached to the object. You may set this flag temporarily when you will be doing a series of assignments to the Value property, and do not want to send a ValueChanged notify for each assignment. Rememeber to clear this flag before doing the last Value assignment or before doing a FireStandardNotifyToAllSinks.
|
| mcobjUserFlagReadOnly | 16384 |
When set, assignment to Value is illegal
|
| mcobjUserFlagSystemObject | 1024 |
When set, Name and TagNumber cannot be changed
|
| mcobjUserFlagNotifyOnGetValue | 512 |
When set, an mcobjSNCode_BeforeGetValue SpecialNotify is sent to standard notify clients before the Value property is returned. This allows a notify sink to set the object's Value only when it is requested. See McObject.Value for more discussion.
|
| mcobjUserFlagOptionBase1 | 256 |
The Value property is exposed using base indexing of 1 for array data. If not set, then 0 based array indexing is used
|
| mcobjUserFlagsCustomMask | 16711680 |
Bits 24 thru 17 are available for the caller's custom use
|
| mcobjUserFlagsSettableMask | 16762724 |
Only these bits are settable, all others are reserved. Assignments are automatically and silently masked by this value.
|
Remarks
Many flag bits have system-defined meanings. The user-settable flags are enumerated in the mcobjUserFlags constant.
|
UserFlags Property
