Función MgmGetFirstMfe (mgm.h)

  • Artículo

La función MgmGetFirstMfe recupera las MFE a partir del principio de la lista MFE. La función puede recuperar cero, una o más MFE. El número de MFE devuelto depende del tamaño de las MFE y del tamaño del búfer proporcionado por el cliente cuando se llama a la función.

Los datos devueltos en el búfer se ordenan primero por grupo y, a continuación, por los orígenes de un grupo.

Sintaxis

DWORD MgmGetFirstMfe(
  [in, out] PDWORD pdwBufferSize,
  [in, out] PBYTE  pbBuffer,
  [in, out] PDWORD pdwNumEntries
);

Parámetros

[in, out] pdwBufferSize

En la entrada, pdwBufferSize es un puntero a una ubicación de memoria de tamaño DWORD que contiene el tamaño, en bytes, de pbBuffer.

En la salida, si el valor devuelto es ERROR_INSUFFICIENT_BUFFER, pdwBufferSize recibe el tamaño mínimo pbBuffer debe ser para contener el MFE; de lo contrario, el valor de pdwBufferSize permanece sin cambios.

[in, out] pbBuffer

En la entrada, el cliente debe proporcionar un puntero a un búfer.

En la salida, pbBuffer contiene una o varias MFE. Cada MFE es una estructura MIB_IPMCAST_MFE .

[in, out] pdwNumEntries

En la entrada, el cliente debe proporcionar un puntero a una ubicación de memoria de tamaño DWORD.

En la salida, pdwNumEntries recibe el número de MFE contenidos en pbBuffer.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Valor Significado
ERROR_CAN_NOT_COMPLETE
 No se pudo completar la llamada a esta función.
ERROR_INSUFFICIENT_BUFFER
 El búfer especificado es demasiado pequeño para incluso una MFE. El cliente debe comprobar el valor de pdwBufferSize para el tamaño mínimo del búfer necesario para recuperar una MFE.
ERROR_MORE_DATA
 Hay más MFE disponibles.
ERROR_NO_MORE_ITEMS
 No hay más MFE disponibles. Se devolvieron cero o más MFE; compruebe el valor de pdwNumEntries para comprobar cuántos MFE se devolvieron.
 
 

Comentarios

Esta función se utiliza para comenzar la recuperación secuencial de las MFE; use MgmGetNextMfe para continuar con el proceso de recuperación.

En general, para recuperar MFE, primero llame a MgmGetFirstMfe. A continuación, llame a MgmGetNextMfe una o varias veces, hasta que no haya más MFE para devolver. Cada llamada a MgmGetNextMfe debe comenzar después de la última MFE devuelta por la llamada anterior a MgmGetNextMfe (o la llamada inicial a MgmGetFirstMfe). Para ello, el cliente especifica el último origen y grupo en el búfer devuelto por una llamada anterior.

Nota El tamaño mínimo del búfer al que apunta pbBuffer no es fijo; es diferente para cada MFE. Use la macro sizeof(MIB_IPMCAST_MFE) para determinar el tamaño de cada MFE devuelto en el búfer.
 

Requisitos

Requisito Value
Cliente mínimo compatible No se admite ninguno
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado mgm.h
Library Rtm.lib
Archivo DLL Rtm.dll

Consulte también

MIB_IPMCAST_MFE

MgmGetMfe

MgmGetNextMfe