adGetUnitInfoByPosition
Retrieves the AdUnitInfo for the unit in the specified position.
- AdResult adGetUnitInfoByPosition(
- AdInterfacePtr theInterface,
- const char * thePositionName,
- AdUnitInfo ** theInfoOut );
| Routine | Required Header | Distribution |
|---|---|---|
| adGetUnitInfoByPosition | <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
- thePositionName
- [in] String identifier of the position registered with AdRegisterPosition
- theInfoOut
- [out] A pointer to the unit's info. Valid until the next call to adThink.
Remarks
This will be the default unit information if either adQueryForActiveUnits or adDownloadNewCreatives has not completed.
Section Reference: Gamespy Advertising SDK
See Also: adRegisterPosition, adQueryForActiveUnits, adDownloadNewCreatives, adGetUnitInfoByID