PxMcGetVarsizedOverhead()

return the overhead of a varsized memory class.

APPLIES TO

1.0.0

SYNOPSIS
PxSize_t PxMcGetVarsizedOverhead (PxMc_t mcid);
ARGUMENTS






mcid




The memory class object

















RETURN VALUES






    

  • 

    Overhead per block of a varsized memory class
    

    • 

  • 

    PXMAXUINT in case of error
    

    • 







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










PxMcGetVarsizedOverhead returns the overhead per block of a varsized memory class.






















IMPLEMENTATION GUIDELINES
















Before call






    

  • 

    mcid must be the symbolic value PXMcSystemdefault specifying the system memory class (V)
    

    • 



















After call






    

  • 

    The function returns 0xFFFFFFFF (-1U) if the given memory class 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"

PxSize_t Size = PxMcGetVarsizedOverhead(mcid)