3.1.4.2.4 FaxObs_GetInstallType (Opnum 2)

The client calls the FaxObs_GetInstallType (Opnum 2) method to obtain information about the server installation.

In response, the server MUST return information describing the type of installation, the operating system platform, and the type of the product.

 error_status_t FaxObs_GetInstallType(
   [in] handle_t hBinding,
   [out] LPDWORD InstallType,
   [out] LPDWORD InstalledPlatforms,
   [out] LPDWORD ProductType
 );

hBinding: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FaxObs_ConnectionRefCount (section 3.1.4.2.2) method call used to connect to the fax server.

InstallType: A pointer to a DWORD ([MS-DTYP] section 2.2.9) value where, upon return from this call, the fax server MUST write the install type of the fax server. This value MUST be 0x00000002 for FAX_INSTALL_SERVER. The values 0x00000001, 0x00000004, and 0x00000008 are reserved for local use.

InstalledPlatforms: A pointer to a DWORD value where on return from this call, the fax server MUST write the installed platform (microprocessor type) of the fax server. This value MUST be one of the following:

Value/code	Meaning
FAX_INSTALLED_PLATFORM_X86 0x00000001	The fax server is running on an Intel x86 platform.
FAX_INSTALLED_PLATFORM_MIPS 0x00000002	The fax server is running on a MIPS platform.
FAX_INSTALLED_PLATFORM_ALPHA 0x00000004	The fax server is running on a DEC Alpha platform.
FAX_INSTALLED_PLATFORM_PPC 0x00000008	The fax server is running on a PowerPC platform.

ProductType: A pointer to a DWORD value where on return from this call, the fax server MUST write the installed product type of the fax server. This value MUST be one of the following:

Value/code	Meaning
PRODUCT_TYPE_WINNT 0x00000001	The fax server is a workstation-type operating system.
PRODUCT_TYPE_SERVER 0x00000002	The fax server is a server-type operating system.

Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return the following error code, one of the fax-specific errors that are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF] section 2.2.

Return value/code	Description
ERROR_INVALID_FUNCTION 0x00000001	The fax server is unable to retrieve the requested installation information.

Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying RPC protocol, [MS-RPCE].