MsiCloseHandle function

Expand
This topic has not yet been rated - Rate this topic

MsiCloseHandle function

Applies to: desktop apps only

The MsiCloseHandle function closes an open installation handle.

Syntax

UINT MsiCloseHandle(
  __in  MSIHANDLE hAny
);

Parameters

hAny [in]

Specifies any open installation handle.

Return value

ValueMeaning
ERROR_INVALID_HANDLE

An invalid handle was passed to the function.

ERROR_SUCCESS

The function succeeded.

 

Remarks

MsiCloseHandle must be called from the same thread that requested the creation of the handle.

The following functions supply handles that should be closed after use by calling MsiCloseHandle:

MsiCreateRecord
MsiGetActiveDatabase
MsiGetLastErrorRecord
MsiOpenPackage
MsiOpenProduct
MsiOpenDatabase
MsiDatabaseOpenView
MsiViewFetch
MsiViewGetColumnInfo
MsiDatabaseGetPrimaryKeys
MsiGetSummaryInformation
MsiEnableUIPreview

Note that when writing custom actions, it is recommended to use variables of type PMSIHANDLE because the installer closes PMSIHANDLE objects as they go out of scope, whereas you must close MSIHANDLE objects by calling MsiCloseHandle.

For example, if you use code like this:

MSIHANDLE hRec = MsiCreateRecord(3);

Change it to:

PMSIHANDLE hRec = MsiCreateRecord(3);

Requirements

Version

Windows Installer 5.0 on Windows Server 2012, Windows 8, Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. Windows Installer on Windows Server 2003, Windows XP, and Windows 2000. See the Windows Installer Run-Time Requirements for information about the minimum Windows service pack that is required by a Windows Installer version.

Header

Msi.h

Library

Msi.lib

DLL

Msi.dll

See also

Handle Management Functions

 

 

Build date: 5/5/2012

Did you find this helpful?
(1500 characters remaining)
Community Additions ADD
Hex Values for Win32 error codes Published as part of Open Protocol Specifications

As a part of the Open Protocol Specifications, the hex values for Win32 error codes can now be found at http://msdn2.microsoft.com/en-us/library/cc231199.aspx.

8/30/2009
vb.net syntax
<DllImport("msi.dll", CharSet:=CharSet.Unicode)> _
Public Shared Function MsiCloseHandle(ByVal hAny As Integer) As UInt32
End Function
8/30/2009
C# syntax
[DllImport("msi.dll", CharSet=CharSet.Unicode)]
internal static extern uint MsiCloseHandle(int hAny);
5/10/2009