Prev Next

EnumMonitors info  Overview  Group

The EnumMonitors function initializes an array of structures with data describing the monitors for the specified server.

BOOL EnumMonitors(

    LPTSTR pName,

// pointer to server name

    DWORD Level,

// structure level

    LPBYTE pMonitors,

// pointer to structure array

    DWORD cbBuf,

// size, in bytes, of buffer

    LPDWORD pcbNeeded,

// addr. of variable with no. of bytes copied (or required)

    LPDWORD pcReturned 

// addr. of variable with no. of job info. structures copied

   );

Parameters

pName
Points to a null-terminated string that specifies the name of the server on which the monitors reside. If this parameter is NULL, the local monitors are enumerated.
Level
Specifies the version of the structure pointed to by pMonitors.
pMonitors
Points to an array of MONITOR_INFO_1 or MONITOR_INFO_2 structures.
cbBuf
Specifies the size, in bytes, of the buffer pointed to by pMonitors.
pcbNeeded
Points to a variable that receives the number of bytes copied if the function succeeds or the number of bytes required if cbBuf is too small.
pcReturned
Points to a variable that receives the number of structures that were returned in the buffer pointed to by pMonitors.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

See Also

MONITOR_INFO_1, MONITOR_INFO_2