PxOpoolGetType()

Return the object pool type.

APPLIES TO

1.0.0

SYNOPSIS

PxOpoolType_t PxOpoolGetType (PxOpool_t OpoolId);

ARGUMENTS

OpoolId: An object pool id

RETURN VALUES

The object pool type

ERROR CODES

PXERR_OPOOL_ILLOPOOL

OpoolId is not a valid object pool id

PXERR_GLOBAL_ILLEGAL_CORE

The requested object pool is not on the same core

DESCRIPTION

PxOpoolGetType returns the type of the given object pool. The type can be either PXOpoolVirtual, PXOpoolReal, or PXOpoolIllegalType if an invalid object pool is given.

IMPLEMENTATION GUIDELINES

Before call

OpoolId must be a valid PXROS-HR object pool. The validity of OpoolId may be checked by the following macros:
- PxOpoolIdIsValid() must be true.
- PxOpoolIdGet() must not be _PXIllegalObjId.
- PxOpoolIdError() must be PXERR_NOERROR otherwise the returned error code has to be interpreted (C).

After call

The function returns PXOpoolIllegalType if the given object pool is invalid. In this case PxGetError must be called to check which error has occurred. (F)

Best Practice

No restrictions.

SEE ALSO

USAGE

#include "pxdef.h"

PxOpoolType_t Type = PxOpoolGetType(OpoolId);