Steam::Events::EventResult Struct Reference

Result information returned by operations. More...

#include <events.hpp>

Static Public Member Functions
static EventResult	ok ()
	Construct a successful result.
static EventResult	fail (std::string msg)
	Construct a failure result.

Public Attributes
bool	success
	Indicates whether the operation succeeded.
std::string	message
	Optional error or diagnostic message.

Detailed Description

Result information returned by operations.

Convention:

• success == true indicates the request completed successfully.
• message contains a diagnostic message only when success == false.

Member Function Documentation

fail()

EventResult Steam::Events::EventResult::fail ( std::string msg )

inlinestatic

Construct a failure result.

Parameters

msg	Failure description.

---

The documentation for this struct was generated from the following file:

• include/steamclient/events.hpp