.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH Extract 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBExtract\fR (CABINET.3)
.SH SYNOPSIS
HRESULT Extract
 (
  SESSION* \fIdest\fR,
  LPCSTR   \fIszCabName\fR
 )

.SH DESCRIPTION
.PP
Extracts the contents of the cabinet file to the specified destination. 

.SH PARAMS
\fIdest\fR \fB[In/Out]\fR  Controls the operation of Extract. See \fBNOTES\fR.
.PP
\fIszCabName\fR \fB[In]\fR  Filename of the cabinet to extract.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR \fBS_OK\fR. 
.PP
\fBFailure:\fR \fBE_FAIL\fR. 

.SH NOTES
.PP
The following members of the \fIdest\fR struct control the operation of Extract: FileSize [Out] The size of all files extracted up to CurrentFile. Error [Out] The error in case the extract operation fails. FileList [In]  A linked list of filenames. Extract only extracts. files from the cabinet that are in this list. FileCount [Out] Contains the number of files in FileList on. completion. Operation [In]  See Operation. Destination [In]  The destination directory. CurrentFile [Out] The last file extracted. FilterList [In]  A linked list of files that should not be extracted. 
.PP
Operation If Operation contains \fBEXTRACT_FILLFILELIST\fR, then FileList will be filled with all the files in the cabinet. If Operation contains \fBEXTRACT_EXTRACTFILES\fR, then only the files in the FileList will be extracted from the cabinet. \fBEXTRACT_FILLFILELIST\fR can be called by itself, but \fBEXTRACT_EXTRACTFILES\fR must have a valid FileList in order to succeed. If Operation contains both \fBEXTRACT_FILLFILELIST\fR and \fBEXTRACT_EXTRACTFILES\fR, then all the files in the cabinet will be extracted. 

.SH IMPLEMENTATION
.PP
Declared in \fB"cabinet.h"\fR. 
.PP
Implemented in \fB"dlls/cabinet/cabinet_main.c"\fR. 
.PP
Debug channel \fB"cabinet"\fR.