wpclsFindObjectFirst - Parameters

somSelf (M_WPObject *) - input

Pointer to the WPObject class object.

pClasslist (PCLASS) - output

Pointer to an array of class objects.

The final element of the array must be NULL.

If this parameter is specified, only objects that are descended from the specified object classes are returned.

phFind (PHFIND) - output

Address of the handle returned by this method.

This handle is used with subsequent calls to wpclsFindObjectNext and wpclsFindObjectEnd.

pszTitle (PSZ) - input

Pointer to the title specification for objects to be searched.

This title may include the wildcard characters * and ?.

If this parameter is specified, only objects whose titles match the title specification are returned.

Folder (WPFolder *) - input

Pointer to the folder in which to find objects.

This pointer can be determined by issuing a call to the wpclsQueryFolder method.

fSubfolders (BOOL) - input

Scope indicator.

TRUE

Search Folder and all folders in its tree.
FALSE
Search only the folder specified by Folder.

pExtendedCriteria (PVOID) - input

Pointer to the extended search criteria.

Points to a buffer that contains the class-specific extended search criteria.

If this parameter is specified, only the objects that match the specified extended search criteria are returned.

If this parameter is NULL, objects of all classes are returned.

pBuffer (POBJECT) - output

Pointer to a buffer that contains an array of object pointers.

The size of this buffer must be large enough to hold the number of requested entries specified by pCount.

pCount (PULONG) - in/out

Address of the number of matching entries requested in pBuffer.

On return, this field contains the number of entries placed into pBuffer.

rc (BOOL) - returns

Success indicator.

TRUE

Successful completion.
FALSE
Error occurred.
If wpclsFindObjectFirst returns FALSE, the wpQueryError method can be called to retrieve the error code. Error codes include the following:

WPERR_BUFFER_OVERFLOW

The pBuffer was not large enough to fit all objects matching the specified criteria. The wpclsFindObjectNext method should be called to retrieve the rest of the objects matching the specified criteria.
WPERR_OBJECT_NOT_FOUND
No objects matching the specified criteria were found.

---

[Back: wpclsFindObjectFirst Return Value - rc]
[Next: wpclsFindObjectFirst - Remarks]