StgIsStorageFile function (coml2api.h)
The StgIsStorageFile function indicates whether a particular disk file contains a storage object.
Syntax
HRESULT StgIsStorageFile(
[in] const WCHAR *pwcsName
);
Parameters
[in] pwcsName
Pointer to the null-terminated Unicode string name of the disk file to be examined. The pwcsName parameter is passed uninterpreted to the underlying file system.
Return value
StgIsStorageFile function can also return any file system errors or system errors wrapped in an HRESULT. See Error Handling Strategies and Handling Unknown Errors
Remarks
At the beginning of the disk file underlying a storage object is a signature distinguishing a storage object from other file formats. The StgIsStorageFile function is useful to applications whose documents use a disk file format that might or might not use storage objects.
If a root compound file has been created in transacted mode but not yet committed, this method still return S_OK.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 2000 Professional [desktop apps | UWP apps] |
Minimum supported server | Windows 2000 Server [desktop apps | UWP apps] |
Target Platform | Windows |
Header | coml2api.h (include Objbase.h) |
Library | Ole32.lib |
DLL | Ole32.dll |