FaxAccessCheck

A fax client application calls the FaxAccessCheck function to query the fax access privileges of a user.

BOOL WINAPI FaxAccessCheck(
  HANDLE FaxHandle,  // handle to the fax server
  DWORD AccessMask   // set of access level bit flags
);

Parameters

FaxHandle

[in] Specifies a fax server handle returned by a call to the FaxConnectFaxServer function.

AccessMask

[in] Specifies a DWORD variable that contains a set of bit flags defining a user's fax access permissions. This parameter can be one or more of the following generic access permissions: FAX_READ, FAX_WRITE, and FAX_ALL_ACCESS. It can also be one or more of the following specific access permissions:

FAX_JOB_SUBMIT
FAX_JOB_QUERY
FAX_CONFIG_QUERY
FAX_CONFIG_SET
FAX_PORT_QUERY
FAX_PORT_SET
FAX_JOB_MANAGE

For a detailed description of these values, see Generic Fax Access Rights and Specific Fax Access Rights.

Return Values

If the user has the required permission, the return value is nonzero.

If the user does not have the required permission, the return value is zero, and GetLastError returns ERROR_SUCCESS.

If the function fails, the return value is also zero, but GetLastError returns an error code other than ERROR_SUCCESS.

Remarks

The fax service is a secure service. Users must have certain access privileges to successfully call fax service functions. Call the FaxAccessCheck function to programmatically check a user's fax access permissions. For more information, see Checking the Access Rights of Users and Fax Client User Access Rights.

The fax service administration application, a Microsoft Management Console (MMC) snap-in component, is also available for users to query and modify job access, port access, and global configuration data access privileges.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable with BackOffice Small Business Server.
  Header: Declared in Winfax.h.
  Library: Included as a resource in Winfax.dll.
  Unicode: Implemented as Unicode and ANSI versions on all platforms.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Functions, FaxConnectFaxServer