Método ISyncMgrSyncItem::GetName (syncmgr.h)

Obtiene el nombre para mostrar de la interfaz de usuario del elemento de sincronización.

Sintaxis

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parámetros

[out] ppszName

Tipo: LPWSTR*

Cuando este método vuelve, contiene un puntero a un búfer que contiene el nombre para mostrar del elemento. Esta cadena tiene una longitud máxima MAX_SYNCMGR_NAME incluido el carácter nulo de terminación. Las cadenas de mayor longitud se truncarán.

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

Si se produce un error en GetName o se devuelve una cadena vacía en ppszItemID, el elemento de sincronización no se muestra en la carpeta del controlador y el Centro de sincronización no intentará sincronizarlo.

El identificador recuperado por este método está disponible en la interfaz de usuario de la carpeta del controlador como la propiedad System.DisplayName (PKEY_DisplayName).

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

El Centro de sincronización llama a este método cada vez que se llama al método UpdateItem .

En implementaciones anteriores del Administrador de sincronización, esta información se recuperó a través de la estructura SYNCMGRHANDLERINFO .

Ejemplos

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

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    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