-
Notifications
You must be signed in to change notification settings - Fork 23
QuantumGate::Local::GetPeer
Karel Donk edited this page Aug 4, 2020
·
6 revisions
Gets a QuantumGate::Peer
object representing a (connected) peer on the local instance. Use the QueryPeers()
member function to get the peers connected to the local instance.
Result<Peer> GetPeer(const PeerLUID pluid) const noexcept;
Name | Description |
---|---|
pluid |
The QuantumGate::PeerLUID (Locally Unique Identifier) of the peer. |
Returns a QuantumGate::Result
indicating whether the operation was successful and containing a QuantumGate::Peer
when successful. The following Result
s are possible:
Value | Description |
---|---|
QuantumGate::ResultCode::Succeeded |
The operation succeeded. |
QuantumGate::ResultCode::NotRunning |
The operation failed because the instance isn't running. |
QuantumGate::ResultCode::PeerNotFound |
The operation failed because the peer wasn't found. The PeerLUID may be invalid or the peer may have been disconnected and removed in the mean time. |