StgCreateDocfile (Compact 2013)
3/26/2014
This function creates a new compound file storage object using the OLE-provided compound file implementation for the IStorage interface.
Syntax
WINOLEAPI StgCreateDocfile(
const WCHAR* pwcsName,
DWORD grfMode,
DWORD reserved,
IStorage** ppstgOpen
);
Parameters
- pwcsName
[in] Pointer to the path of the compound file to create. It is passed un-interpreted to the file system. This can be a relative name or NULL. If NULL, a temporary compound file is allocated with a unique name.
- grfMode
[in] Specifies the access mode to use when opening the new storage object. For more information, see the STGM enumeration. If the caller specifies transacted mode together with STGM_CREATE or STGM_CONVERT, the overwrite or conversion takes place at the time the storage object is opened and therefore is not revertible.
- reserved
[in] Reserved; set to 0 (zero).
- ppstgOpen
[out] Pointer to the location of the IStorage pointer to the new storage object.
Return Value
One of the values described in the following table is returned.
Value |
Description |
|---|---|
S_OK |
Indicates that the compound file was successfully created. |
STG_E_ACCESSDENIED |
Indicates that access was denied because the caller has insufficient permission, or another caller has the file open and locked. |
STG_E_FILEALREADYEXISTS |
Indicates that the compound file already exists and grfMode is set to STGM_FAILIFTHERE. |
STG_E_INSUFFICIENTMEMORY |
Indicates that the compound file was not created due to a lack of memory. |
STG_E_INVALIDFLAG |
Indicates a bad flag combination in the grfMode pointer. |
STG_E_INVALIDNAME |
Indicates a bad name in the pwcsName parameter. |
STG_E_INVALIDPOINTER |
Indicates a bad pointer in the pwcsName parameter or the ppStgOpen parameter. |
STG_E_LOCKVIOLATION |
Indicates that access was denied because another caller has the file open and locked. |
STG_E_SHAREVIOLATION |
Indicates that access was denied because another caller has the file open and locked. |
STG_E_TOOMANYOPENFILES |
Indicates that the compound file was not created due to a lack of file handles. |
STG_S_CONVERTED |
Indicates that the specified file was successfully converted to Storage format. |
This function can also return any file system errors or Microsoft Win32 errors wrapped in an HRESULT.
Remarks
The StgCreateDocfile function creates a new storage object using the COM-provided, compound-file implementation for the IStorage interface. The name of the open compound file can be retrieved by calling the IStorage::Stat method.
StgCreateDocfile creates the file if it does not exist. If it does exist, the use of the STGM_CREATE, STGM_CONVERT, and STGM_FAILIFTHERE flags in the grfMode parameter indicate how to proceed. For more information about these values, see the STGM enumeration.
If the compound file is opened in transacted mode (the grfMode parameter specifies STGM_TRANSACTED) and a file with this name already exists, the existing file is not altered until all outstanding changes are committed. If the calling process lacks write access to the existing file, because of access restrictions in the file system, the grfMode parameter can only specify STGM_READ and not STGM_WRITE or STGM_READWRITE. The resulting new open compound file can still be written to, but a subsequent commit operation will fail. In transacted mode, write permissions are enforced at commit time.
Specifying STGM_SIMPLE provides a much faster implementation of a compound file object in a limited, but frequently -used, case. This can be used by applications that require a compound file implementation with multiple streams and no storages. The simple mode does not support all of the methods on IStorage. For more information, see the STGM enumeration.
If the grfMode parameter specifies STGM_TRANSACTED and no file yet exists with the name specified by the pwcsName parameter, the file is created immediately. In an access-restricted file system, the caller must have write permissions in the file system directory in which the compound file is created. If STGM_TRANSACTED is not specified, and STGM_CREATE is specified, an existing file with the same name is destroyed before creating the new file.
StgCreateDocfile can be used to create a temporary compound file by passing a NULL value for the pwcsName parameter. However, these files are temporary only in the sense that they have a system-provided unique name - likely one that is meaningless to the user. The caller is responsible for deleting the temporary file when it is finished with it, unless STGM_DELETEONRELEASE was specified for the grfMode parameter.
Passing into this function any invalid and, under some circumstances, NULL pointers results in unexpected termination of the application.
To determine whether the platform supports this function, see Determining Supported COM APIs.
Requirements
Header |
objbase.h |
Library |
ole32.lib |