Yeppp!
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Enumerations | Functions

Enumerations

enum  YepEnumeration {
  YepEnumerationStatus = 0, YepEnumerationCpuArchitecture = 1, YepEnumerationCpuVendor = 2, YepEnumerationCpuMicroarchitecture = 3,
  YepEnumerationCpuBriefName = 4, YepEnumerationCpuFullName = 5, YepEnumerationGenericIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureUnknown), YepEnumerationGenericSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureUnknown),
  YepEnumerationGenericSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureUnknown), YepEnumerationX86IsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureX86), YepEnumerationX86SimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureX86), YepEnumerationX86SystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureX86),
  YepEnumerationARMIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureARM), YepEnumerationARMSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureARM), YepEnumerationARMSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureARM), YepEnumerationMIPSIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureMIPS),
  YepEnumerationMIPSSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureMIPS), YepEnumerationMIPSSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureMIPS), YepEnumerationPowerPCIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitecturePowerPC), YepEnumerationPowerPCSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitecturePowerPC),
  YepEnumerationPowerPCSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitecturePowerPC), YepEnumerationIA64IsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureIA64), YepEnumerationIA64SimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureIA64), YepEnumerationIA64SystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureIA64),
  YepEnumerationSPARCIsaFeature = YEP_ENUMERATION_ISA_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureSPARC), YepEnumerationSPARCSimdFeature = YEP_ENUMERATION_SIMD_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureSPARC), YepEnumerationSPARCSystemFeature = YEP_ENUMERATION_SYSTEM_FEATURE_FOR_ARCHITECTURE(YepCpuArchitectureSPARC)
}
 Indicates how to interpret integer value from one of Yeppp! enumerations. More...
 

Functions

enum YepStatus yepLibrary_GetString (enum YepEnumeration enumerationType, Yep32u enumerationValue, void *buffer, YepSize *length)
 Returns a string representation of an integer value in a enumeration. More...
 

Detailed Description

Enumeration Type Documentation

Indicates how to interpret integer value from one of Yeppp! enumerations.

See Also
yepLibrary_GetString
Enumerator
YepEnumerationStatus 

The enumeration type is YepStatus.

YepEnumerationCpuArchitecture 

The enumeration type is YepCpuArchitecture.

YepEnumerationCpuVendor 

The enumeration type is YepCpuVendor.

YepEnumerationCpuMicroarchitecture 

The enumeration type is YepCpuMicroarchitecture.

YepEnumerationCpuBriefName 

The enumeration type is one of the processor packages for which a brief name (without vendor name) will be requested.

YepEnumerationCpuFullName 

The enumeration type is one of the processor packages for which a full name (including vendor name) will be requested.

YepEnumerationGenericIsaFeature 

The enumeration type is one of the common ISA features constants.

YepEnumerationGenericSimdFeature 

The enumeration type is one of the common SIMD features constants.

YepEnumerationGenericSystemFeature 

The enumeration type is one of the common non-ISA or system features constants.

YepEnumerationX86IsaFeature 

The enumeration type is one of the x86 ISA features constants.

YepEnumerationX86SimdFeature 

The enumeration type is one of the x86 SIMD features constants.

YepEnumerationX86SystemFeature 

The enumeration type is one of the x86 non-ISA or system features constants.

YepEnumerationARMIsaFeature 

The enumeration type is one of the ARM ISA features constants.

YepEnumerationARMSimdFeature 

The enumeration type is one of the ARM SIMD features constants.

YepEnumerationARMSystemFeature 

The enumeration type is one of the ARM non-ISA or system features constants.

YepEnumerationMIPSIsaFeature 

The enumeration type is one of the MIPS ISA features constants.

YepEnumerationMIPSSimdFeature 

The enumeration type is one of the MIPS SIMD features constants.

YepEnumerationMIPSSystemFeature 

The enumeration type is one of the MIPS non-ISA or system features constants.

YepEnumerationPowerPCIsaFeature 

The enumeration type is one of the PowerPC ISA features constants.

YepEnumerationPowerPCSimdFeature 

The enumeration type is one of the PowerPC SIMD features constants.

YepEnumerationPowerPCSystemFeature 

The enumeration type is one of the PowerPC non-ISA or system features constants.

YepEnumerationIA64IsaFeature 

The enumeration type is one of the IA64 ISA features constants.

YepEnumerationIA64SimdFeature 

The enumeration type is one of the IA64 SIMD features constants.

YepEnumerationIA64SystemFeature 

The enumeration type is one of the IA64 non-ISA or system features constants.

YepEnumerationSPARCIsaFeature 

The enumeration type is one of the SPARC ISA features constants.

YepEnumerationSPARCSimdFeature 

The enumeration type is one of the SPARC SIMD features constants.

YepEnumerationSPARCSystemFeature 

The enumeration type is one of the SPARC non-ISA or system features constants.

Function Documentation

enum YepStatus yepLibrary_GetString ( enum YepEnumeration  enumerationType,
Yep32u  enumerationValue,
void *  buffer,
YepSize length 
)

Returns a string representation of an integer value in a enumeration.

Parameters
[in]enumerationTypeIndicates the type of integer value passed to the function in enumerationValue parameter.
[in]enumerationValueThe enumeration value of type specified in enumerationType which must be converted to string.
[out]bufferAn output buffer of size specified by the length parameter. On successfull return the buffer will contain the string representation of enumerationValue. The string representation does not include the terminating zero. If the function fails, the content of the buffer is not changed.
[in,out]lengthOn function call this variable must contain the length (in bytes) of the buffer. On successfull return this variable will contain the length (in bytes) of the string written to the buffer. If the function fails with YepStatusInsufficientBuffer error, on return the length variable will contain the required size of the buffer. In the function fails with any other error, this variable is unchanged.
Return values
YepStatusOkThe string is successfully stored in the buffer.
YepStatusNullPointerBuffer or length pointer is null.
YepStatusInvalidArgumentEither enumerationType or enumerationValue contain values unknown to the library.
YepStatusInsufficientBufferThe output buffer is too small for the string. The content of the output buffer is unchanged, and the required size of the buffer is returned in the length variable.
Examples:
CpuInfo.c.