Share via

PEMSTATUS( ) Function

  • Article

Returns an attribute for a property, event, method, or object.

PEMSTATUS(oObjectName | cClassName, cProperty | cEvent | cMethod
   | cObject, nAttribute)

Return Values

Character or Logical

Parameters

  • oObjectName
    Specifies the object for which a property, event, method, or object attribute is returned. oObjectName can be any expression that evaluates to an object, such as an object reference, an object memory variable, or an object array element. If oObjectName is a container object such as a form, you can determine attributes for objects within the container object.

  • cClassName
    Specifies the class for which a property, event, or method attribute is returned.

  • cProperty
    Specifies the property for which an attribute is returned.

  • cEvent
    Specifies the event for which an attribute is returned.

  • cMethod
    Specifies the method for which an attribute is returned.

  • cObject
    Specifies the object for which an attribute is returned. For example, you can use the AddObject method to add an object to a container object, and then use PEMSTATUS( ) to return information about the object added to the container object.

  • nAttribute
    A numeric value that specifies which property, event, or method attribute is returned.

    The following table lists the values for nAttribute and the corresponding property, event, or method attribute.

    nAttribute Property, event, or method attribute
    0 Changed (properties only). A logical true (.T.) is returned if the property value has changed from its original, default value; otherwise a logical false (.F.) is returned.
    1 Read-only (properties only). A logical true (.T.) is returned if the property is read-only; otherwise a logical false (.F.) is returned.
    2 Protected. A logical true (.T.) is returned if the property, event, or method is a protected; otherwise a logical false (.F.) is returned.
    3 Type. A character string is returned indicating if cProperty, cEvent,cMethod or cObject is a property, event, method or object. Property, Event, Method, or Object is returned.
    4 User-defined. A logical true (.T.) is returned if the property, event, or method is a user-defined property, event, or method; otherwise a logical false (.F.) is returned.
    5 Defined property, event, method, or object. A logical true (.T.) is returned if the property, event, method, or object exists for oObjectName or cClassName, otherwise a logical false (.F.) is returned.
    6 Inherited property, event, method, or object. A logical true (.T.) is returned if the property, event, method, or object for oObjectName or cClassName was inherited from another object or class, otherwise a logical false (.F.) is returned.

Remarks

PEMSTATUS( ) does not detect for changes in specific array elements if the array is passed.

See Also

CREATE FORM Command | GETPEM( ) Function | SYS(1269) – Property Information | SYS(1270) – Object Location | SYS(1271) - Object's .SCX File | SYS(1272) – Object Hierarchy