IReplStore::GetFolderInfo

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method creates a new HREPLFLD of a folder for the specified object type name and returns a pointer to the IReplObjHandler interface that is used to serialize and deserialize all items in this folder.

Syntax

HRESULT GetFolderInfo(
  LPSTR lpszName,
  HREPLFLD* phFolder,
  IUnknown** ppObjHandler
);

Parameters

• lpszName
  [in] Long pointer to the null-terminated string that contains the name of the object type as taken from the registry.

• phFolder
  [out] Pointer to the handle to the folder.

• ppObjHandler
  [out] Pointer to a pointer to the IReplObjHandler interface.

Return Value

Returns NOERROR if the method completed successfully, otherwise returns HRESULT_FROM_WIN32.

Remarks

GetFolderInfo is the only method in IReplStore that creates or modifies a HREPLFLD structure for the folder. The ActiveSync manager calls this method to get a folder handle for the specified object type. Object types are configured into the registry, where object type name and other relevant information about an object type are stored. Note that the handle pointed to by phFolder may or may not be NULL when called. If phFolder points to a handle that has a NULL value, the ActiveSync service provider should create a new handle for the specified folder. If phFolder points to a pointer that has a value, the ActiveSync service provider should modify the data indicated by this handle.

Requirements

See Also

Reference

IReplObjHandler
IReplStore
HREPLFLD