Share via

IGameStatistics::GetStatistic Method

  • Article

Retrieves the value of the statistic value, if it is set.

Syntax

virtual HRESULT GetStatistic(
         WORD categoryIndex,
         WORD statIndex,
         LPWSTR *pName,
         LPWSTR *pValue
)

Parameters

  • categoryIndex
    [in] The category to query
  • statIndex
    [in] Statistic index to query.
  • pName
    [out, optional] Receives the name of statistic if set, NULL otherwise.
  • pValue
    [out, optional] Receives the value of statistic if set, NULL otherwise.

Return Value

Returns S_OK if the name and value was successful retrieved. Returns E_INVALIDARG if categoryIndex or statIndex are outside the maximum values.

Remarks

Uninitialized statistics names and values will return NULL pointers. The returned strings should be freed using CoTaskMemFree.

Requirements

Header: Declared in gameux.h.

See Also

IGameStatistics::SetStatistic
IGameStatistics