PxMcGetType()

Get type of a memory class.

APPLIES TO

1.0.0

SYNOPSIS
PxMcType_t PxMcGetType (PxMc_t mcid);
ARGUMENTS
mcid

The memory class object

RETURN VALUES
  • The memory classes type

ERROR CODES

PXERR_MC_ILLMC

mcid is not a valid memory class

PXERR_GLOBAL_ILLEGAL_CORE

The requested memory class is not on the same core

DESCRIPTION

PxMcGetType returns the memory classes type:

  • PXMcVarsized

  • PXMcVarsizedAdjusted

  • PXMcVarsizedAligned

  • PXMcFixsized

  • PxMcBuddyMemory

  • PXMcTypeLast if an invalid memory class is given.

IMPLEMENTATION GUIDELINES
Before call
  • mcid must be:

    • a valid PXROS-HR memory class created with a PxMcRequest call (V). The validity of mcid may also be checked by the PxMcIsValid macro (F).

    • the symbolic value PXMcSystemdefault specifying the system memory class (V)

    • the symbolic value PXMcTaskdefault specifying the task’s memory class (V)

After call
  • The function returns PXMcTypeLast if the given memory class is invalid.

Best Practice
  • No restrictions.