A program or Workplace Shell object would call the following methods to get general information about an object. A Workplace Shell object would override these methods to define its characteristics.

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³Method Name                   ³Description                   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpIdentify                    ³Returns a string that is      ³
³                              ³unique within a given         ³
³                              ³container that identifies the ³
³                              ³specified object.             ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryConfirmations          ³Returns the set of            ³
³                              ³confirmations that are set for³
³                              ³this object.                  ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryDefaultHelp            ³Returns the object's default  ³
³                              ³help panel.                   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryNameClashOptions       ³Returns the set of options    ³
³                              ³that are not available on the ³
³                              ³name clash dialog for this    ³
³                              ³object.                       ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryTitle                  ³Returns the object's title.   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryTrueStyle              ³Queries this object's current ³
³                              ³class true style.             ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryDefaultHelp         ³Returns the class default help³
³                              ³panel. This help panel is used³
³                              ³for all objects of this class.³
³                              ³The default help panel can be ³
³                              ³changed for an individual     ³
³                              ³object if:                    ³
³                              ³                              ³
³                              ³o The object overrides        ³
³                              ³  wpQueryDefaultHelp.         ³
³                              ³o The wpSetDefaultHelp method ³
³                              ³  is called.                  ³
³                              ³o The wpSetup method is called³
³                              ³  with the HELPPANEL keyword. ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQuerySetting             ³Returns a settings value for  ³
³                              ³an abstract class object. An  ³
³                              ³abstract class object would   ³
³                              ³override this method if it    ³
³                              ³saved its class settings.     ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryStyle               ³Returns the class style. See  ³
³                              ³Class Styles.                 ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryTitle               ³Returns the class title. This ³
³                              ³title is used for all objects ³
³                              ³of this class, including the  ³
³                              ³class template. The title can ³
³                              ³be changed for an individual  ³
³                              ³object if:                    ³
³                              ³                              ³
³                              ³o The object overrides        ³
³                              ³  wpQueryTitle.               ³
³                              ³o The wpSetTitle method is    ³
³                              ³  called.                     ³
³                              ³o The wpSetup method is       ³
³                              ³  called with the TITLE       ³
³                              ³  keyword, when the user      ³
³                              ³  edits the object's title    ³
³                              ³  on the General page of the  ³
³                              ³  Settings notebook, or when  ³
³                              ³  the user edits the          ³
³                              ³  object's title under        ³
³                              ³  the icon.                   ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ

A program or Workplace Shell object would call the following methods to get general information about an object. These methods are not normally overridden.

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³Method Name                   ³Description                   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpFindTaskRec                 ³An object is sent this message³
³                              ³to return information specific³
³                              ³to the task being performed in³
³                              ³a task thread.                ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpGetTrueClassName            ³Returns the class name for the³
³                              ³given object.                 ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryContainerFlagPtr       ³Returns the pointer to a flag ³
³                              ³indicating whether or not the ³
³                              ³object is in a container.     ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryCoreRecord             ³Returns the pointer to the    ³
³                              ³object's MINIRECORDCORE data  ³
³                              ³structure.                    ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryDefaultIconPos         ³Returns the default icon      ³
³                              ³position used when this object³
³                              ³is first inserted into a      ³
³                              ³folder.                       ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryError                  ³Returns the last error code   ³
³                              ³set by calling the object's   ³
³                              ³wpSetError. This is normally  ³
³                              ³an error code being returned  ³
³                              ³by a failing instance method. ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryFolder                 ³Returns the object pointer for³
³                              ³the folder containing the     ³
³                              ³object.                       ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryHandle                 ³Returns the object's unique   ³
³                              ³persistent handle.            ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryObjectID               ³Returns the object's          ³
³                              ³identifier. The object        ³
³                              ³identifier is set by calling  ³
³                              ³wpSetObjectID for the object  ³
³                              ³or by calling wpSetup for the ³
³                              ³object with the OBJECTID      ³
³                              ³keyword.                      ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryScreenGroupID          ³Returns the screen group      ³
³                              ³identifier of the application ³
³                              ³running for this object.      ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryStyle                  ³Returns the object's current  ³
³                              ³style flags. See Object Styles³
³                              ³.                             ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpQueryStyle                  ³Returns the object's style.   ³
³                              ³See Object Styles.            ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryError               ³Returns the last error code   ³
³                              ³set by calling the class'     ³
³                              ³wpclsSetError. This is        ³
³                              ³normally an error code that is³
³                              ³returned by a failing class   ³
³                              ³method.                       ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryFolder              ³Returns the pointer to the    ³
³                              ³folder object that corresponds³
³                              ³to the specified file system  ³
³                              ³path.                         ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryObject              ³Returns the pointer to the    ³
³                              ³object that corresponds to the³
³                              ³specified persistent object   ³
³                              ³handle.                       ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryStyle               ³Returns the object class'     ³
³                              ³style. See Class Styles.      ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ

A program or Workplace Shell object would call the following methods to set general information about an object. These methods are not normally overridden.

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³Method Name                   ³Description                   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpModifyStyle                 ³Sets or clears individual     ³
³                              ³flags within the object's     ³
³                              ³style. This method call is an ³
³                              ³atomic operation as only the  ³
³                              ³specified style flags are     ³
³                              ³changed, even if other running³
³                              ³threads try to modify the     ³
³                              ³style flags at the same time. ³
³                              ³See Object Styles.            ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpSetDefaultHelp              ³Sets the object's default help³
³                              ³panel.                        ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpSetDefaultIconPos           ³Sets the object's default icon³
³                              ³position which is used when it³
³                              ³is inserted into a folder.    ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpSetError                    ³Sets the current error code   ³
³                              ³for the object. This method is³
³                              ³normally called by an instance³
³                              ³method to pass an error code  ³
³                              ³back to the caller.           ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpSetObjectID                 ³Sets the object's identifier. ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpSetStyle                    ³Sets the object's style. This ³
³                              ³method exists only for        ³
³                              ³compatibility with old        ³
³                              ³objects. All new or changed   ³
³                              ³objects should use            ³
³                              ³wpModifyStyle instead. See    ³
³                              ³Object Styles.                ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpSetTaskRec                  ³Adds, replaces, or deletes a  ³
³                              ³task data block.              ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpSetTitle                    ³Sets the object's title.      ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsSetError                 ³Sets the current error code   ³
³                              ³for the class. This method is ³
³                              ³normally called by a class    ³
³                              ³method to pass an error code  ³
³                              ³back to the caller.           ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ

A program or Workplace Shell object would call the following method to set general information about an object. A Workplace Shell object would override this method to define its characteristics.

ÚÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÂÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
³Method Name                   ³Description                   ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsQueryInstanceClass       ³Returns the name of a class   ³
³                              ³that this object can become.  ³
ÃÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÅÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ´
³wpclsSetSetting               ³Sets a settings value for an  ³
³                              ³abstract class object. An     ³
³                              ³abstract class object would   ³
³                              ³override this method if it    ³
³                              ³wants to save its class       ³
³                              ³settings.                     ³
ÀÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÁÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÙ


[Back] [Next]