ISyncMgrHandlerInfo::GetTypeLabel 메서드(syncmgr.h)

처리기 형식에 대한 레이블을 가져옵니다. 일반적으로 디바이스의 모델 또는 해당하는 처리기별 ID 문자열을 제공합니다.

구문

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

매개 변수

[out] ppszTypeLabel

형식: LPWSTR*

이 메서드가 반환되면 레이블 문자열을 포함하는 버퍼에 대한 포인터를 포함합니다.

반환 값

형식: HRESULT

성공하면 S_OK 반환하고, 그렇지 않으면 오류 값을 반환합니다. 메서드가 실패하면 ppszTypeLabel 에 빈 문자열이 포함됩니다.

설명

레이블 값은 폴더 UI에서 System.Sync.HandlerTypeLabel(PKEY_Sync_HandlerTypeLabel) 속성으로 표시됩니다. Sync Center는 UpdateHandler 메서드를 호출할 때마다 이 메서드를 호출합니다.

처리기는 CoTaskMemAlloc을 통해 ppszTypeLabel이 가리키는 문자열 버퍼를 할당합니다. 동기화 센터는 CoTaskMemFree를 통해 문자열 버퍼의 할당을 취소합니다.

예제

다음 예제에서는 이 메서드의 구현을 보여줍니다.

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;
}

요구 사항

요구 사항	값
지원되는 최소 클라이언트	Windows Vista [데스크톱 앱만 해당]
지원되는 최소 서버	Windows Server 2008 [데스크톱 앱만 해당]
대상 플랫폼	Windows
헤더	syncmgr.h