Export (0) Print
Expand All

Requirements (COM)

Many topics that introduce the syntax of an API element contain information about the build and run-time requirements for using the element. Different documentation sets may use a different title and subset of information. The most common formats are as follows:

Format 1

Requirements

Client: Included in OperatingSystemVer.

Server: Included in OperatingSystemVer.

Redistributable: Requires Redist on OperatingSystemVer.

Header: Declared in HeaderFile; include IncHeaderFile.

Library: Use LibraryFile.

Unicode: Implemented as Unicode and ANSI versions.

Format 2

Requirements

Windows NT/2000/XP: Included in OperatingSystemVer.

Windows 95/98/Me: Included in OperatingSystemVer.

Redistributable: Requires Redist on OperatingSystemVer.

Header: Declared in HeaderFile; include IncHeaderFile.

Library: Use LibraryFile.

Unicode: Implemented as Unicode and ANSI versions.

The Client line lists all client platforms that support the element natively. For example, Windows XP, Windows 2000 Professional, Windows NT Workstation, Windows Me, Windows 98, and Windows 95 are all client platforms.

The Server line lists all server platforms that support the element natively. For example, Windows Server 2003, Windows 2000 Server, and Windows NT Server are all server platforms. Each server platform has multiple SKUs. If the element is supported on only certain SKUs, they are listed individually. Otherwise, all SKUs are represented. For example, Windows 2000 Server indicates support on Windows 2000 Server, Windows 2000 Advanced Server, and Windows 2000 Datacenter Server.

The Windows NT/2000/XP line indicates whether an element is supported natively on Windows Server 2003, Windows XP, Windows 2000, or Windows NT, which are all based on the Windows NT code base. If an element is not supported, the line reads "Unsupported."

The Windows 95/98/Me line indicates whether an element is supported natively on Windows 95, Windows 98, or Windows Me. If an element is not supported, the line reads "Unsupported," or is omitted.

The Redistributable line indicates additional requirements to support an element that is not supported natively in a particular version of Windows. For elements that are only supported natively, this line is omitted.

The Header line indicates the header file that defines an element. This value can be an .h file, .idl file, or .odl file. This line can indicate that your code should include a different header file (one that includes the header file in which the element is defined, plus other required headers or definitions). If the header file is supplied by the user, or no header file is required, this line is omitted.

The Library line indicates the file used to resolve calls to a function or member. This value can be a .lib file, .dll file, or .tlb file. If the library is supplied by the user, or the element type does not require a library, this line is omitted.

The Unicode line indicates whether an element exists as both a Unicode (W) version and an ANSI (A) version. Otherwise, this line is omitted.

Example

The following is an example requirements block.

Windows NT/2000/XP: Included in Windows NT 4.0 and later.

Windows 95/98/Me: Included in Windows 98 and later.

Redistributable: Requires IE 4.01 or later on Windows 95.

Header: Declared in Winuser.h; include Windows.h.

Library: Use User32.lib.

Unicode: Implemented as Unicode and ANSI versions.

The function that includes this requirements block is supported natively on Windows Server 2003, Windows XP, Windows 2000, Windows NT 4.0, Windows Me, and Windows 98. To call this function on Windows 95, you must install Internet Explorer 4.01 or later. To compile code that uses this function, you must include Windows.h in the source file (although to look at the function declaration, you must open Winuser.h). To link code that uses this function, you must pass User32.lib to the linker.

Send comments about this topic to Microsoft.

Community Additions

Show:
© 2014 Microsoft