wpclsFindOneObject - Remarks

wpSetup override by wpclsFindOneObject

The following table shows the keyname-value pairs for the wpclsFindOneObject method.

┌─────────────────────────┬─────────────┬───────────────────────────┐
│KEYNAME                  │VALUE        │DESCRIPTION                │
├─────────────────────────┼─────────────┼───────────────────────────┤
│CLASSLIST                │class-name   │This specifies the name of │
│                         │             │the object class to be     │
│                         │             │searched for.  For example,│
│                         │             │to search for bitmaps you  │
│                         │             │would specifiy             │
│                         │             │CLASSLIST=WPBitmap.        │
├─────────────────────────┼─────────────┼───────────────────────────┤
│DEFAULTCRITERIA          │YES          │This specifies to use the  │
│                         │             │default file system        │
│                         │             │criteria when doing a      │
│                         │             │search.  Hidden files will │
│                         │             │not be found.              │
├─────────────────────────┼─────────────┼───────────────────────────┤
│                         │NO           │This specifies to not use  │
│                         │             │the default file system    │
│                         │             │criteria when doing a      │
│                         │             │search.                    │
├─────────────────────────┼─────────────┼───────────────────────────┤
│DIALOG                   │YES          │This specifies that a      │
│                         │             │dialog is to be presented  │
│                         │             │to the user, allowing the  │
│                         │             │user to change the search  │
│                         │             │criteria.                  │
├─────────────────────────┼─────────────┼───────────────────────────┤
│                         │NO           │This specifies that the    │
│                         │             │user cannot change the     │
│                         │             │search criteria. The caller│
│                         │             │must set up the search     │
│                         │             │criteria exactly as        │
│                         │             │desired.                   │
├─────────────────────────┼─────────────┼───────────────────────────┤
│NAMEFILTER               │search-string│This specifies the name of │
│                         │             │the object to be located.  │
│                         │             │This name may contain      │
│                         │             │wildcard characters.  For  │
│                         │             │example, to search for all │
│                         │             │.BMP files you would       │
│                         │             │specify NAMEFILTER=*.BMP.  │
├─────────────────────────┼─────────────┼───────────────────────────┤
│STARTFOLDER              │path         │This specifies the         │
│                         │             │fully-qualified path to the│
│                         │             │folder from which to start │
│                         │             │searching for the specified│
│                         │             │objects. The path name may │
│                         │             │start with "?:", indicating│
│                         │             │the specified folder is on │
│                         │             │the boot drive.            │
├─────────────────────────┼─────────────┼───────────────────────────┤
│SUBTREESRCH              │YES          │This specifies that        │
│                         │             │subfolders are to be       │
│                         │             │searched.                  │
├─────────────────────────┼─────────────┼───────────────────────────┤
│                         │NO           │This specifies that        │
│                         │             │subfolders are not to be   │
│                         │             │searched. Only the         │
│                         │             │specified folder is        │
│                         │             │searched.                  │
└─────────────────────────┴─────────────┴───────────────────────────┘


[Back: wpclsFindOneObject - Parameters]
[Next: wpclsFindOneObject - Usage]