PropVariantToStrRet 함수(propvarutil.h)

PROPVARIANT 구조체에서 문자열을 추출하여 STRRET 구조체에 배치합니다.

구문

PSSTDAPI PropVariantToStrRet(
  [in]  REFPROPVARIANT propvar,
  [out] STRRET         *pstrret
);

매개 변수

[in] propvar

형식: REFPROPVARIANT

원본 PROPVARIANT 구조체에 대한 참조입니다.

[out] pstrret

형식: STRRET*

STRRET 구조를 가리킵니다. 이 함수가 반환되면 추출된 문자열의 복사본을 포함하도록 구조체가 초기화됩니다.

반환 값

형식: HRESULT

이 함수가 성공하면 S_OK 반환합니다. 그러지 않으면 HRESULT 오류 코드를 반환합니다.

설명

이 도우미 함수는 PROPVARIANT 구조체의 문자열 값을 STRRET 구조체로 변환하려는 애플리케이션에서 사용됩니다. instance 경우 IShellFolder::GetDisplayNameOf를 구현하는 애플리케이션에서 이 함수가 유용할 수 있습니다.

source PROPVARIANT 에 VT_LPWSTR 또는 VT_BSTR 형식이 있는 경우 이 함수는 문자열을 추출하여 STRRET 구조체에 배치합니다. 그렇지 않으면 PROPVARIANT 구조체의 값을 문자열로 변환하려고 시도합니다. 변환이 불가능한 경우 PropVariantToString 은 실패 코드를 반환합니다. 가능한 변환 목록은 PropVariantChangeType 을 참조하세요. 참고로, VT_EMPTY 성공적으로 ""로 변환됩니다.

PropVariantChangeType에서 제공하는 변환 외에도 PropVariantToString에 다음과 같은 특수 사례가 적용됩니다.

  • 벡터 반환 PROPVARIANTs는 "; "를 사용하여 각 요소를 구분하여 문자열로 변환됩니다. 예를 들어 PropVariantToString 은 3개의 정수{3, 1, 4}의 벡터를 문자열 "3; 1; 4". 세미콜론은 현재 로캘과 독립적입니다.
  • VT_BLOB, VT_STREAM, VT_STREAMED_OBJECT 및 VT_UNKNOWN 값은 지원되지 않는 인코딩을 사용하여 문자열로 변환됩니다. 이러한 방식으로 만든 문자열을 디코딩할 수 없으며 나중에 형식이 변경될 수 있습니다.
추출에 성공하면 함수는 STRRET_WSTR 사용하여 STRRET 구조체의 uType 멤버를 초기화하고 해당 구조체의 pOleStr 멤버를 문자열의 할당된 복사본을 가리키도록 설정합니다. 호출 애플리케이션은 더 이상 필요하지 않은 경우 CoTaskMemFree 또는 StrRetToStr 을 사용하여 이 문자열을 해제해야 합니다.

예제

더 큰 프로그램의 일부로 포함할 다음 예제에서는 PropVariantToString을 사용하여 PROPVARIANT의 문자열 값에 액세스하는 방법을 보여 줍니다.

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

HRESULT hr = ppropstore->GetValue(PKEY_FileName, &propvar);

if (SUCCEEDED(hr))

{

    // PKEY_FileName is expected to produce a VT_LPWSTR or VT_EMPTY value.

    // PropVariantToStrRet will convert VT_EMPTY to "".

    // If this were an implementation of IShellFolder::GetDisplayNameOf, strName would be a parameter and the caller would free the memory associated with the STRRET

    STRRET strName;

    hr = PropVariantToStrRet(propvar, &strName);

    if (SUCCEEDED(hr))

    {

        // strName is now valid

 

        if (strName.uType == STRRET_WSTR)

        {

            CoTaskMemFree(strName.pOleStr);

        }

    }

    else

    {

        // the extraction failed

    }

    PropVariantClear(&propvar);

}

요구 사항

요구 사항
지원되는 최소 클라이언트 WINDOWS XP SP2, Windows Vista [데스크톱 앱만 해당]
지원되는 최소 서버 Windows Server 2003 SP1 [데스크톱 앱만 해당]
대상 플랫폼 Windows
헤더 propvarutil.h
라이브러리 Propsys.lib
DLL Propsys.dll(버전 6.0 이상)
재배포 가능 파일 WDS(Windows 데스크톱 검색) 3.0

추가 정보

InitPropVariantFromString

PropVariantChangeType

PropVariantGetStringElem

PropVariantToString

PropVariantToStringAlloc

PropVariantToStringVector

StrRetToStr

VariantToStrRet