Compartir a través de

Método ISyncMgrHandlerInfo::GetTypeLabel (syncmgr.h)

  • Artículo

Obtiene una etiqueta para el tipo de controlador. Normalmente, proporciona el modelo del dispositivo o una cadena de identidad específica del controlador equivalente.

Sintaxis

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Parámetros

[out] ppszTypeLabel

Tipo: LPWSTR*

Cuando este método vuelve, contiene un puntero a un búfer que contiene la cadena de etiqueta.

Valor devuelto

Tipo: HRESULT

Devuelve S_OK si se realiza correctamente; de lo contrario, un valor de error. Si se produce un error en el método, ppszTypeLabel contiene una cadena vacía.

Comentarios

El valor de etiqueta se muestra como la propiedad System.Sync.HandlerTypeLabel (PKEY_Sync_HandlerTypeLabel) en la interfaz de usuario de la carpeta. El Centro de sincronización llama a este método cada vez que se llama al método UpdateHandler .

El controlador es responsable de asignar el búfer de cadena al que apunta ppszTypeLabel a través de CoTaskMemAlloc. Sync Center desasigna el búfer de cadena a través de CoTaskMemFree.

Ejemplos

En el ejemplo siguiente se muestra una implementación de este método.

STDMETHODIMP CMyDeviceHandler::GetTypeLabel(__out LPWSTR *ppszTypeLabel)
{
    LPWSTR pszTypeLabel = NULL;

    HRESULT hr = LoadStringAlloc(g_hmodThisDll, 
                                 IDS_HANDLER_TYPE_LABEL,
                                 &pszTypeLabel);
    if (SUCCEEDED(hr))
    {
        // Duplicate for the caller.
        hr = SHCoAllocString(pszTypeLabel, ppszTypeLabel);
        LocalFree(pszTypeLabel);
    }

    return hr;
}

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