Edit

Share via

STGOPTIONS structure (coml2api.h)

  • Article

The STGOPTIONS structure specifies features of the storage object, such as sector size, in the StgCreateStorageEx and StgOpenStorageEx functions.

Syntax

typedef struct tagSTGOPTIONS {
  USHORT      usVersion;
  USHORT      reserved;
  ULONG       ulSectorSize;
  const WCHAR *pwcsTemplateFile;
} STGOPTIONS;

Members

usVersion

Specifies the version of the STGOPTIONS structure. It is set to STGOPTIONS_VERSION.

Note  When usVersion is set to 1, the ulSectorSize member can be set. This is useful when creating a large-sector documentation file. However, when usVersion is set to 1, the pwcsTemplateFile member cannot be used.
 
In Windows 2000 and later:  STGOPTIONS_VERSION can be set to 1 for version 1.

In Windows XP and later:  STGOPTIONS_VERSION can be set to 2 for version 2.

For operating systems prior to Windows 2000:  STGOPTIONS_VERSION will be set to 0 for version 0.

reserved

Reserved for future use; must be zero.

ulSectorSize

Specifies the sector size of the storage object. The default is 512 bytes.

pwcsTemplateFile

Specifies the name of a file whose Encrypted File System (EFS) metadata will be transferred to a newly created Structured Storage file. This member is valid only when STGFMT_DOCFILE is used with StgCreateStorageEx.

In Windows XP and later:  The pwcsTemplateFile member is only valid if version 2 or later is specified in the usVersion member.

Remarks

STGOPTIONS is only supported on Unicode APIs.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Header coml2api.h (include Objbase.h)

See also

Compound File Implementation Limits

StgCreateStorageEx

StgOpenStorageEx