PropVariantToString 함수(propvarutil.h)

아티클
08/25/2023

PROPVARIANT 구조체에서 문자열 값을 추출합니다.

구문

PSSTDAPI PropVariantToString(
  [in]  REFPROPVARIANT propvar,
  [out] PWSTR          psz,
  [in]  UINT           cch
);

매개 변수

[in] propvar

형식: REFPROPVARIANT

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

[out] psz

형식: PWSTR

문자열 버퍼를 가리킵니다. 이 함수가 반환되면 버퍼는 NULL 종료 유니코드 문자열 값으로 초기화됩니다.

[in] cch

형식: UINT

psz가 가리키는 버퍼의 크기(문자)입니다.

반환 값

형식: HRESULT

이 함수는 이러한 값 중 하나를 반환할 수 있습니다.

반환 코드	설명
S_OK	값이 추출되고 결과 버퍼가 NULL 종료되었습니다.
STRSAFE_E_INSUFFICIENT_BUFFER	버퍼 공간이 부족하여 복사 작업이 실패했습니다. 대상 버퍼에는 의도한 결과의 잘린 null 종료 버전이 포함됩니다. 잘림이 허용되는 상황에서는 반드시 실패 조건으로 간주되지 않을 수 있습니다.
일부 기타 오류 값	다른 이유로 추출에 실패했습니다.

설명

이 도우미 함수는 호출 애플리케이션에서 PROPVARIANT 가 문자열 값을 보유해야 하는 위치에서 사용됩니다. instance 경우 속성 저장소에서 값을 가져오는 애플리케이션에서 이를 사용하여 문자열 속성에 대한 문자열 값을 안전하게 추출할 수 있습니다.

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

종료 NULL 외에도 최대 cch-1 문자는 psz가 가리키는 버퍼에 기록됩니다. 원본 PROPVARIANT 의 값이 버퍼에 맞는 것보다 긴 경우 잘린 NULL 종결된 문자열 복사본이 버퍼에 기록되고 이 함수는 STRSAFE_E_INSUFFICIENT_BUFFER 반환합니다. 결과 문자열은 항상 NULL 종료됩니다.

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

벡터 반환 PROPVARIANTs는 "; "를 사용하여 각 요소를 구분하여 문자열로 변환됩니다. 예를 들어 PropVariantToString 은 3개의 정수{3, 1, 4}의 벡터를 문자열 "3; 1; 4". 세미콜론은 현재 로캘과 독립적입니다.
VT_BLOB, VT_STREAM, VT_STREAMED_OBJECT 및 VT_UNKNOWN 값은 지원되지 않는 인코딩을 사용하여 문자열로 변환됩니다. 이러한 방식으로 만든 문자열을 디코딩할 수 없으며 나중에 형식이 변경될 수 있습니다.

예제

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

// IPropertyStore *ppropstore;

// Assume variable ppropstore is initialized and valid

PROPVARIANT propvar = {0};

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

if (SUCCEEDED(hr))

{

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

    // PropVariantToString will convert VT_EMPTY to "".

    // The application decided that it only needs the first 127 characters of the title, so the buffer 

    // has size 128 to account for the terminating NULL.

    WCHAR szTitle[128];

    hr = PropVariantToString(propvar, szTitle, ARRAYSIZE(szTitle));

    if (SUCCEEDED(hr) || hr == STRSAFE_E_INSUFFICIENT_BUFFER)

    {

        // szTitle is now valid and contains up to 127 characters from propvar and a terminating NULL

    }

    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