GxSmuGetThernalOverloadStatus

Applies To

GX3104, GX3116e

Purpose

Returns the board thermal overload status string.

Syntax

GxSmuGetThermalOverloadStatus (nHandle, pszThermalOverloadStatus, nMaxLen, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3104 or GX3116e board.
pszThermalOverloadStatus
PSTR
Buffer to the returned the board thermal overload status string.
If no thermal overload, the function returns: "No Thermal Overload occurred".
In case of a board thermal overload the function returns: "Thermal Overload occurred on channel(s): ", followed by the channels number
nMaxLen
SHORT
The size of the summary string buffer.  
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function returns the board thermal overload status.

The function is supported by GX3104 PCB Rev E and above and all revisions of the GX3116e. Use the GxSmuGetBoardSummary() API, to check the board’s PCB rev.

Example

The following example returns the board’s board thermal overload status string:

 

CHAR sz[256];

SHORT nHandle, nStatus;

GxSmuGetThermalOverloadStatus (nHandle, sz, sizeof sz, &nStatus);

 

See Also

GxSmuInitialize, GxSmuGetBoardSummary, GxSmuGetErrorString, GxSmuGetStatusRegister