Edit

PartyEndpoint::GetSharedProperty

  • Article

Gets the value of a shared property.

Syntax

PartyError GetSharedProperty(  
    PartyString key,  
    PartyDataBuffer* value  
)

Parameters

key   PartyString

The key of the shared property to retrieve.

value   PartyDataBuffer*
output

An output struct that receives a pointer to the property's value and the length in bytes of the value data. If the property was not found, the call succeeds, but the value is nullptr and the byte length is 0.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyManager::GetErrorMessage().

Remarks

If there is no property associated with the key, the resulting value is nullptr. The returned value is only valid until the next call to PartyManager::StartProcessingStateChanges().

Requirements

Header: Party.h

See also

PartyEndpoint
PartyNetwork::CreateEndpoint