PEMSTATUS( ) Function

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

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

Parameters

  • oObjectName
    Specifies the object for which the property, event, method, or object attribute to return. 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 in the container object.

  • cClassName
    Specifies the class for which the property, event, or method attribute to return.

  • cProperty
    Specifies the property for which the attribute to return.

  • cEvent
    Specifies the event for which the attribute to return.

  • cMethod
    Specifies the method for which the attribute to return.

  • cObject
    Specifies the object for which the attribute to return.

    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
    Specifies a numeric value that determines the property, event, or method attribute to return.

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

    nAttribute

    Property, event, or method attribute

    0

    Changed.

    If the property value, method, or event has changed, PEMSTATUS( ) returns a logical True (.T.). Otherwise, PEMSTATUS( ) returns logical False (.F.).

    1

    Read-only (properties only).

    If the property is read-only, PEMSTATUS( ) returns a logical True (.T.). Otherwise, PEMSTATUS( ) returns a logical False (.F.).

    2

    Protected.

    If the property, event, or method is protected, PEMSTATUS( ) returns a logical True (.T.). Otherwise, PEMSTATUS( ) returns a logical False (.F.).

    3

    Type.

    PEMSTATUS( ) returns a character string, for example, Property, Event, Method, or Object, indicating whether cProperty, cEvent, cMethod or cObject is a property, event, method or object.

    4

    User-defined.

    If the property, event, or method is a user-defined property, event, or method, PEMSTATUS( ) returns a logical True (.T.). Otherwise, PEMSTATUS( ) returns a logical False (.F.).

    5

    Defined property, event, method, or object.

    If the property, event, method, or object exists for oObjectName or cClassName, PEMSTATUS( ) returns a logical True (.T.). Otherwise, or for hidden native properties, PEMSTATUS( ) returns a logical False (.F.).

    6

    Inherited property, event, method, or object.

    If the property, event, method, or object for oObjectName or cClassName was inherited from another object or class, PEMSTATUS( ) returns logical True (.T.). Otherwise, PEMSTATUS( ) returns a logical False (.F.).

Return Value

Character or Logical. PEMSTATUS( ) returns a character string or logical value for the attribute specified.

Remarks

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

See Also

Reference

CREATE FORM Command

GETPEM( ) Function

SYS(1269) - Property Information

SYS(1270) - Object Location

SYS(1271) - Object's .SCX File

SYS(1272) - Object Hierarchy

Other Resources

Functions