PropVariantToStringWithDefault 함수(propvarutil.h)

아티클
03/01/2024

PROPVARIANT 구조체의 문자열 속성 값을 추출합니다. 값이 없으면 지정된 기본값이 반환됩니다.

구문

PSSTDAPI_(PCWSTR) PropVariantToStringWithDefault(
  [in] REFPROPVARIANT propvarIn,
  [in] LPCWSTR        pszDefault
);

매개 변수

[in] propvarIn

형식: REFPROPVARIANT

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

[in] pszDefault

형식: LPCWSTR

현재 값이 없는 경우 사용할 기본 유니코드 문자열 값에 대한 포인터입니다. NULL일 수 있습니다.

반환 값

형식: PCWSTR

문자열 값 또는 기본값 또는 기본값을 반환합니다.

설명

이 도우미 함수는 호출하는 애플리케이션에서 PROPVARIANT 가 문자열 값을 보유할 것으로 예상하는 위치에서 사용되며, 그렇지 않은 경우 기본값을 사용하려고 합니다. instance 경우 속성 저장소에서 값을 가져오는 애플리케이션에서 이를 사용하여 문자열 속성에 대한 문자열 값을 안전하게 추출할 수 있습니다.

source PROPVARIANT 에 VT_LPWSTR 또는 VT_BSTR 형식이 있는 경우 이 도우미 함수는 source PROPVARIANT의 값에 대한 포인터를 반환합니다. 소스 PROPVARIANT 에 VT_EMPTY 형식이 있거나 변환이 불가능한 경우 PropVariantToStringWithDefault 는 pszDefault에서 제공하는 기본값을 반환합니다.

이 함수는 매개 변수에 제공된 데이터에 대한 포인터를 반환합니다. 따라서 애플리케이션은 결과가 더 이상 사용되지 않을 때까지 매개 변수에 제공된 데이터가 유효한지 확인해야 합니다.

예제

더 큰 프로그램의 일부로 포함할 다음 예제에서는 PropVariantToStringWithDefault를 사용하여 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.
     // The application developer decided to treat VT_EMPTY or invalid values as ""
     PCWSTR pszTitle = PropVariantToStringWithDefault(propvar, L"");
     // pszTitle is now valid.
     PropVariantClear(&propvar);
}
// ... later in the program ...
hr = ppropstore->GetValue(PKEY_Comment, &propvar);
if (SUCCEEDED(hr))
{
         // PKEY_Comment is expected to produce a VT_LPWSTR or VT_EMPTY value.
         // The application developer decided to treat VT_EMPTY as NULL
         PCWSTR pszComment = PropVariantToStringWithDefault(propvar, NULL);
         if (pszComment)
         {
                 // pszComment is valid
         }
         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