adGetUnitInfoByID

GameSpy SDK

adGetUnitInfoByID

Retrieves the AdUnitInfo the specified unit.

AdResult adGetUnitInfoByID(
AdInterfacePtr theInterface,
AdUnitID theUnitID,
AdUnitInfo ** theInfoOut );
RoutineRequired HeaderDistribution
adGetUnitInfoByID<ad.h>SDKZIP

Return Value

This function returns AdResult_NO_ERROR upon success. Otherwise a valid AdResult error condition is returned. (see remarks)

Parameters

theInterface
[in] SDK interface previously initialized using adInitialize
theUnitID
[in] A valid Unit ID
theInfoOut
[out] A pointer to the unit's info. Valid until the next call to adThink.

Remarks

In most cases adGetUnitInfoByPosition should be used. This will be the default unit information if either adQueryForActiveUnits or adDownloadNewCreatives has not completed.