Función RtmLockDestination (rtmv2.h)

  • Artículo

La función RtmLockDestination bloquea o desbloquea un destino en la tabla de enrutamiento. Use esta función para proteger un destino al cambiar punteros opacos.

Sintaxis

DWORD RtmLockDestination(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_DEST_HANDLE   DestHandle,
  [in] BOOL              Exclusive,
  [in] BOOL              LockDest
);

Parámetros

[in] RtmRegHandle

Identificador para el cliente obtenido de una llamada anterior a RtmRegisterEntity.

[in] DestHandle

Identificador del destino que se va a bloquear.

[in] Exclusive

Especifica si se va a bloquear o desbloquear el destino en un modo exclusivo (TRUE) o compartido (FALSE).

[in] LockDest

Especifica si se va a bloquear o desbloquear el destino. Especifique TRUE para bloquear el destino; especifique FALSE para desbloquearlo.

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_ACCESS_DENIED
 El cliente que realiza la llamada no posee este destino.
ERROR_INVALID_HANDLE
 El identificador no es válido.
 
 

Comentarios

Esta función también bloquea las rutas asociadas. Evite bloquear destinos durante largos períodos de tiempo, ya que ningún otro cliente puede acceder al destino y las rutas asociadas hasta que se libere el bloqueo.

Un cliente también puede usar esta función al leer información de un destino, al tiempo que impide los cambios durante la operación de lectura del cliente. En este caso, considere la posibilidad de usar RtmGetDestInfo en su lugar.

Para obtener código de ejemplo con esta función, vea Actualizar una ruta en contexto mediante RtmUpdateAndUnlockRoute.

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 rtmv2.h
Library Rtm.lib
Archivo DLL Rtm.dll

Consulte también

RtmGetOpaqueInformationPointer