STOREINFO
A version of this page is also available for
4/8/2010
This structure contains information about an instance of the store. For more information about its use, see the IReplStore::GetStoreInfo method.
Syntax
typedef struct tagStoreInfo {
UINT cbStruct;
UINT uFlags;
TCHAR szProgId[ 256 ];
TCHAR szStoreDesc[ 200 ];
UINT uTimerRes;
UINT cbMaxStoreId;
UINT cbStoreId;
LPBYTE lpbStoreId;
} STOREINFO, *PSTOREINFO;
Members
- cbStruct
Specifies the size of this structure.
- uFlags
[out] Specifies whether a single thread operation or real-time changes and deletions are supported. See Remarks for the possible values.
- szProgId
[out] A null-terminated string that specifies the ID of the store object. This name is used as a storage object in a structured storage file and must conform to the name standards referred to in IStorage::CreateStorage.
- szStoreDesc
[out] A null-terminated string that contains the description of the store.
- uTimerRes
[in/out] Specifies the resolution of the timer in microseconds. Applicable only when SCF_SIMULATE_RTS is set in uFlags.
- cbMaxStoreId
Specifies the maximum size of the store ID that can be stored in buffer referenced by lpbStoreId.
- cbStoreId
[out] Specifies the actual size of the store ID stored in buffer.
- lpbStoreId
[out] Reference to a buffer that contains the store ID for current store instance.
Remarks
If the client does not support multithreading, it must set fSingleThreadOnly to FALSE so that the server serializes the calls to the methods and makes them all come from the primary thread of the application.
The following table lists the possible values for uFlags.
| Flag | Value | Description |
|---|---|---|
SCF_SINGLE_THREAD |
0x00000001 |
Single thread operation is supported. |
SCF_SIMULATE_RTS |
0x00000002 |
Detection of real-time changes and deletions is supported. |
The szStoreDesc displays a store description to the user whenever szProgId specifies a different store.
The default value for uTimerRes is 5,000. This parameter value is applicable only when uFlags is set to SCF_SIMULATE_RTS.
Requirements
| Header | cesync.h |
| Windows Embedded CE | Windows CE 3.0 and later |
| Windows Mobile | Pocket PC 2000 and later, Smartphone 2002 and later |