MsiGetPropertyA 함수(msiquery.h)

  • 아티클

MsiGetProperty 함수는 설치 관리자 속성의 값을 가져옵니다.

구문

UINT MsiGetPropertyA(
  [in]      MSIHANDLE hInstall,
  [in]      LPCSTR    szName,
  [out]     LPSTR     szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

매개 변수

[in] hInstall

DLL 사용자 지정 작업에 제공되거나 MsiOpenPackage, MsiOpenPackageEx 또는 MsiOpenProduct를 통해 가져온 설치에 대한 핸들입니다.

[in] szName

속성의 이름을 지정하는 null로 끝나는 문자열입니다.

[out] szValueBuf

속성 값을 포함하는 null 종료 문자열을 수신하는 버퍼에 대한 포인터입니다. szValueBuf에 대해 null(value=0)을 전달하여 버퍼 크기를 확인하려고 시도하지 마세요. 빈 문자열(예: "")을 전달하여 버퍼의 크기를 가져올 수 있습니다. 그런 다음 함수는 ERROR_MORE_DATA 반환하고 pchValueBuf 는 종료 null 문자를 포함하지 않고 TCHAR에 필요한 버퍼 크기를 포함합니다. ERROR_SUCCESS 반환할 때 pcchValueBuf 에는 종료 null 문자를 포함하지 않고 버퍼에 기록된 TCHAR 수가 포함됩니다.

[in, out] pcchValueBuf

szValueBuf 변수가 가리키는 버퍼의 크기(TCHAR)를 지정하는 변수에 대한 포인터입니다. 함수가 ERROR_SUCCESS 반환하는 경우 이 변수는 종료 null 문자를 포함하지 않고 szValueBuf에 복사된 데이터의 크기를 포함합니다. szValueBuf 가 충분히 크지 않으면 함수는 ERROR_MORE_DATA 반환하고 pchValueBuf가 가리키는 변수에 종료 null 문자를 포함하지 않고 필요한 크기를 저장합니다.

반환 값

이 함수는 UINT를 반환합니다.

설명

MsiGetProperty 함수에서 검색한 속성의 값이 정의되지 않은 경우 길이가 0인 값과 같습니다. 오류가 아닙니다.

ERROR_MORE_DATA 반환되는 경우 포인터인 매개 변수는 문자열을 보유하는 데 필요한 버퍼의 크기를 제공합니다. ERROR_SUCCESS 반환되면 문자열 버퍼에 기록된 문자 수를 제공합니다. 따라서 버퍼를 지정하는 매개 변수에 대해 빈 문자열(예: "")을 전달하여 버퍼의 크기를 가져올 수 있습니다. Null(value=0)을 전달하여 버퍼의 크기를 확인하려고 시도하지 마세요.

다음 예제에서는 DLL 사용자 지정 작업이 값 버퍼의 크기를 동적으로 결정하여 속성 값에 액세스하는 방법을 보여 줍니다.

UINT __stdcall MyCustomAction(MSIHANDLE hInstall)
{
    TCHAR* szValueBuf = NULL;
    DWORD cchValueBuf = 0;
    UINT uiStat =  MsiGetProperty(hInstall, TEXT("MyProperty"), TEXT(""), &cchValueBuf);
    //cchValueBuf now contains the size of the property's string, without null termination
    if (ERROR_MORE_DATA == uiStat)
    {
        ++cchValueBuf; // add 1 for null termination
        szValueBuf = new TCHAR[cchValueBuf];
        if (szValueBuf)
        {
            uiStat = MsiGetProperty(hInstall, TEXT("MyProperty"), szValueBuf, &cchValueBuf);
        }
    }
    if (ERROR_SUCCESS != uiStat)
    {
        if (szValueBuf != NULL) 
           delete[] szValueBuf;
        return ERROR_INSTALL_FAILURE;
    }

    // custom action uses MyProperty
    // ...

    delete[] szValueBuf;

    return ERROR_SUCCESS;
}

참고

msiquery.h 헤더는 MSiGetProperty를 유니코드 전처리기 상수의 정의에 따라 이 함수의 ANSI 또는 유니코드 버전을 자동으로 선택하는 별칭으로 정의합니다. 인코딩 중립 별칭을 인코딩 중립이 아닌 코드와 혼합하면 컴파일 또는 런타임 오류가 발생하는 불일치가 발생할 수 있습니다. 자세한 내용은 함수 프로토타입에 대한 규칙을 참조하세요.

요구 사항

요구 사항 값
지원되는 최소 클라이언트 Windows Server 2012, Windows 8, Windows Server 2008 R2 또는 Windows 7의 Windows Installer 5.0. Windows Server 2008 또는 Windows Vista의 Windows Installer 4.0 또는 Windows Installer 4.5. Windows Server 2003 또는 Windows XP의 Windows Installer
대상 플랫폼 Windows
헤더 msiquery.h
라이브러리 Msi.lib
DLL Msi.dll

추가 정보

설치 관리자 상태 액세스 함수

Null을 Windows Installer Functions의 인수로 전달