IReplStore::FindFirstItem
Note This interface is not supported on Windows CE 3.0-based platforms.
This method returns a new handle to the first object in a specified folder, if there is any.
HRESULT FindFirstItem(
HREPLFLD hFolder,
HREPLITEM *phItem,
BOOL *pfExist);
Parameters
- hFolder
Handler to a folder. - phItem
[out] Pointer to a handle to the first object in the folder. - pfExist
[out] Pointer to a Boolean value that is set to TRUE if there is an object in the folder.
Return Values
One of the values described in the following table is returned.
| Value | Description |
|---|---|
| E_FAIL | There are problems with the enumeration. Replication should ignore the folder. |
| NOERROR | A new HREPLITEM was created for the first object in the folder and its pointer has been returned. |
Remarks
The IReplStore::FindFirstItem method works together with FindNextItem and FindItemClose to enumerate all items in a specified folder. FindFirstItem and FindNextItem are the only methods in IReplStore that can create HREPLITEM for the items. All HREPLITEM structures passed by the ActiveSync service manager are guaranteed to be originally created from these two methods. It is possible that, before FindItemClose is called, a different thread calls methods like DeleteObject that write to the store. Therefore, it is important for the ActiveSync service provider to have some sort of thread synchronization between this method and the methods that write to the store. A typical ActiveSync service provider would use critical section to make sure that, during the time between calls to FindFirstItem and FindItemClose, no write to the store is permitted.
Requirements
| Runs On | Versions | Defined in | Include | Link to |
|---|---|---|---|---|
| Windows CE OS | 2.0 and later | Cesync.h |
Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also
DeleteObject, IReplStore::FindItemClose, IReplStore::FindNextItem, HREPLITEM
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.