PeerContact.GetObjects Method

Definition

Namespace:

System.Net.PeerToPeer.Collaboration

Assembly:

System.Net.dll

Gets the collection of peer objects from a local cache.

Overloads

GetObjects(PeerEndPoint)	Gets the PeerObjectCollection registered by the specified PeerEndPoint and stored in the local cache.
GetObjects(PeerEndPoint, Guid)	Gets the collection of peer objects registered by the specified PeerEndPoint and registered in the PeerApplication identified by the specified Guid.

GetObjects(PeerEndPoint)

Gets the PeerObjectCollection registered by the specified PeerEndPoint and stored in the local cache.

public:
 System::Net::PeerToPeer::Collaboration::PeerObjectCollection ^ GetObjects(System::Net::PeerToPeer::Collaboration::PeerEndPoint ^ peerEndPoint);

[System.Security.SecurityCritical]
public System.Net.PeerToPeer.Collaboration.PeerObjectCollection GetObjects (System.Net.PeerToPeer.Collaboration.PeerEndPoint peerEndPoint);

[<System.Security.SecurityCritical>]
override this.GetObjects : System.Net.PeerToPeer.Collaboration.PeerEndPoint -> System.Net.PeerToPeer.Collaboration.PeerObjectCollection

Public Function GetObjects (peerEndPoint As PeerEndPoint) As PeerObjectCollection

Parameters

peerEndPoint

PeerEndPoint

The endpoint from which to retrieve objects.

Returns

PeerObjectCollection

The PeerObjectCollection associated with the specified PeerEndPoint. If no applications are associated with the endpoint, a collection of size zero (0) is returned.

Attributes

SecurityCriticalAttribute

Exceptions

ArgumentNullException

PeerEndPoint cannot be null.

InvalidOperationException

• The calling peer is not subscribed to the PeerContact associated with the PeerEndPoint.

• The calling peer has not yet called the RefreshData() method.

PeerToPeerException

Unable to complete GetObjects operation.

Remarks

If the calling peer is not subscribed to the PeerContact associated with the specified PeerEndPoint the RefreshData method must be called prior to calling this method.

While the caller is not required to sign-in to the collaboration infrastructure for this method to complete successfully, a successful call to RefreshData or one of the Subscribe methods must have been completed while the caller was previously signed in.

Notes to Callers

Additional overloads are defined on the Peer class instead of the subclasses PeerContact and PeerNearMe.

Calling this method requires a PermissionState of Unrestricted. This state is created when the peer collaboration session begins.

See also

• PeerChangeType
• PeerScope

GetObjects(PeerEndPoint, Guid)

Gets the collection of peer objects registered by the specified PeerEndPoint and registered in the PeerApplication identified by the specified Guid.

public:
 System::Net::PeerToPeer::Collaboration::PeerObjectCollection ^ GetObjects(System::Net::PeerToPeer::Collaboration::PeerEndPoint ^ peerEndPoint, Guid objectId);

[System.Security.SecurityCritical]
public System.Net.PeerToPeer.Collaboration.PeerObjectCollection GetObjects (System.Net.PeerToPeer.Collaboration.PeerEndPoint peerEndPoint, Guid objectId);

[<System.Security.SecurityCritical>]
override this.GetObjects : System.Net.PeerToPeer.Collaboration.PeerEndPoint * Guid -> System.Net.PeerToPeer.Collaboration.PeerObjectCollection

Public Function GetObjects (peerEndPoint As PeerEndPoint, objectId As Guid) As PeerObjectCollection

Parameters

peerEndPoint

PeerEndPoint

The endpoint from which to retrieve objects.

objectId

Guid

The Guid of the PeerObject to be retrieved.

Returns

PeerObjectCollection

The PeerObjectCollection associated with the specified PeerEndPoint. If no applications are associated with the endpoint, a collection of size zero (0) is returned.

Attributes

SecurityCriticalAttribute

Exceptions

ArgumentNullException

PeerEndPoint cannot be null.

InvalidOperationException

• The calling peer is not subscribed to the PeerEndPoint.

• The calling peer has not yet called the RefreshData() method.

PeerToPeerException

Unable to complete GetObjects operation.

Remarks

If the calling peer is not subscribed to the PeerContact associated with the specified PeerEndPoint the RefreshData method must be called prior to calling this method.

While the caller is not required to sign-in to the collaboration infrastructure for this method to complete successfully, a successful call to RefreshData or one of the Subscribe methods must have been completed while the caller was previously signed in.

Notes to Callers

Additional overloads are defined on the Peer class instead of the subclasses PeerContact and PeerNearMe.

Calling this method requires a PermissionState of Unrestricted. This state is created when the peer collaboration session begins.

See also

• PeerChangeType
• PeerScope