PeerGraphOpen function (p2p.h)
The PeerGraphOpen function opens a peer graph that is created previously by either the local node or a remote node. A handle to the peer graph is returned, but a network connection is not established.
NOT_BUILD_WINDOWS_DEPRECATE HRESULT PeerGraphOpen( [in] PCWSTR pwzGraphId, [in] PCWSTR pwzPeerId, [in] PCWSTR pwzDatabaseName, [in] PPEER_SECURITY_INTERFACE pSecurityInterface, [in] ULONG cRecordTypeSyncPrecedence, [in] const GUID *pRecordTypeSyncPrecedence, [out] HGRAPH *phGraph );
Specifies the ID of the peer graph to open. This identifier must be the same as the ID used in the call to PeerGraphCreate.
Specifies the unique ID of the peer opening the graph.
Specifies the name of the database that is associated with this peer graph at the time the graph was created or opened for the first time.
Specifies the security provider for a peer graph. This parameter must specify the same value as the pSecurityInterface specified in the original call to PeerGraphCreate.
Specifies the number of record types in the pRecordTypeSyncPrecedence parameter.
Points to an array of record types. This array specifies the order in which records of the specified record types are synchronized. The order can be zero (0) to N, where 0 is the first record type to be synchronized. If a record type is not specified in the array, it is synchronized in the default order after the types specified in the array are synchronized.
Specify NULL to use the default order. This parameter must be NULL if cRecordTypeSyncPrecedence is zero (0).
Receives a handle to the peer graph that is opened. When this handle is not required or needed, free it by calling PeerGraphClose.
Returns S_OK if an existing database was successfully opened. Otherwise, the function returns one of the following values:
||One of the parameters is not valid.|
||There is not enough memory to perform the specified operation.|
||An existing database is not found, and a new one is created successfully. If an existing database is found and opened successfully, S_OK is returned.|
||The handle to the peer graph is invalid.|
||The peer graph must be initialized by using a call to PeerGraphStartup before using this function.|
If you have developed your own SSP, your application must not call the PeerGraphing API to access data in the graphing database, because that can lead to a deadlock situation. Instead, the application should look at a cached copy of the information.
After PeerGraphOpen is called, an application can subscribe to events or import a database, or both.
Until a peer graph is synchronized at least one time, many functions are not available (for example, PeerGraphListen or any of the record management functions), and any calls made to these functions fail. A peer graph is synchronized at least one time when one of the following occurs:
- A call to PeerGraphOpen returns S_OK, which means that an already synchronized database has been found.
- The PeerGraphCreate function has been called.
- The PEER_GRAPH_EVENT_STATUS_CHANGED event has been triggered, and the PEER_GRAPH_STATUS_SYNCHRONIZED flag of the dwStatus member has been set.
|Minimum supported client||Windows XP with SP2 [desktop apps only],Windows XP with SP1 with the Advanced Networking Pack forWindows XP|
|Minimum supported server||None supported|