Compartir a través de

Método ISyncMgrControl::EnableItem (syncmgr.h)

  • Artículo

Habilita o deshabilita un elemento de sincronización administrado por un controlador especificado.

Sintaxis

HRESULT EnableItem(
  [in] BOOL                  fEnable,
  [in] LPCWSTR               pszHandlerID,
  [in] LPCWSTR               pszItemID,
  [in] HWND                  hwndOwner,
  [in] SYNCMGR_CONTROL_FLAGS nControlFlags
);

Parámetros

[in] fEnable

Tipo: BOOL

TRUE para habilitar; FALSE para deshabilitar.

[in] pszHandlerID

Tipo: LPCWSTR

Puntero a un búfer que contiene el identificador único del controlador. Esta cadena tiene una longitud máxima MAX_SYNCMGR_ID incluido el carácter nulo de terminación.

[in] pszItemID

Tipo: LPCWSTR

Puntero a un búfer que contiene el identificador único del elemento. Esta cadena tiene una longitud máxima MAX_SYNCMGR_ID incluido el carácter nulo de terminación.

[in] hwndOwner

Tipo: HWND

Identificador de una ventana que el elemento puede usar para mostrar cualquier interfaz de usuario necesaria. Este valor puede ser NULL.

[in] nControlFlags

Tipo: SYNCMGR_CONTROL_FLAGS

Valor de la enumeración SYNCMGR_CONTROL_FLAGS que especifica si la habilitación o deshabilitación del elemento se debe realizar de forma sincrónica o asincrónica.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Un elemento habilitado es un elemento que se puede sincronizar.

Si el elemento especificado devuelve SYNCMGR_ICM_QUERY_BEFORE_ENABLE o SYNCMGR_ICM_QUERY_BEFORE_DISABLE en la máscara devuelta desde el método GetCapabilities , el usuario se presenta un cuadro de diálogo de confirmación solicitado antes de que el elemento esté habilitado o deshabilitado. Si no se solicita ninguna interfaz de usuario de consulta o una vez que el usuario confirma la operación, se llama al método Enable del elemento.

Si SYNCMGR_CF_WAIT se establece en el parámetro nControlFlags , EnableItem no devuelve hasta que el Centro de sincronización haya procesado esta notificación.

Ejemplos

En el ejemplo siguiente se muestra el uso de ISyncMgrControl::EnableHandler mediante el procedimiento de un controlador.

void MiscProc(...)
{
    ...

    // Get the Sync Center control object.
    ISyncMgrControl *pControl = NULL;
    
    hr = CoCreateInstance(CLSID_SyncMgrControl, 
                          CLSCTX_SERVER, 
                          IID_PPV_ARGS(&pControl));
    if (SUCCEEDED(hr))
    {
        // Tell Sync Center to disable the item.
        hr = pControl->EnableItem(FALSE, 
                                  s_szMySyncHandlerID,
                                  s_szMySyncHandlerMusicContentID, 
                                  hwnd,
                                  SYNCMGR_CF_WAIT);
        pControl->Release();
    }

    ...

}

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado syncmgr.h