FAX_CONTEXT_INFOA structure (winfax.h)

The FAX_CONTEXT_INFO structure contains information about a fax printer device context. The SizeOfStruct member is required. Information for the other members is supplied by a call to the FaxStartPrintJob function.

Syntax

typedef struct _FAX_CONTEXT_INFOA {
  DWORD SizeOfStruct;
  HDC   hDC;
  CHAR  ServerName[MAX_COMPUTERNAME_LENGTH + 1];
} FAX_CONTEXT_INFOA, *PFAX_CONTEXT_INFOA;

Members

SizeOfStruct

Type: DWORD

Specifies the size, in bytes, of the FAX_CONTEXT_INFO structure. The calling application must set this member to sizeof(FAX_CONTEXT_INFO) before it calls the FaxStartPrintJob function.

hDC

Type: HDC

Handle to a fax printer device context. A call to the FaxStartPrintJob function supplies the data for this member.

ServerName[MAX_COMPUTERNAME_LENGTH + 1]

Type: TCHAR[MAX_COMPUTERNAME_LENGTH+1]

Specifies a variable that contains a null-terminated string that is the fax server name of interest. A call to the FaxStartPrintJob function supplies the data for this member. If the fax server is on the local computer, this member will be empty. The client application does not need to fill in this member.

Remarks

A fax client application can call the FaxStartPrintJob function to retrieve the handle to a fax printer device context. The function returns the handle in a FAX_CONTEXT_INFO structure. The application must call the DeleteDC function to deallocate the handle to the printer device context. For more information, see Printing a Fax to a Device Context.

Note

The winfax.h header defines FAX_CONTEXT_INFO as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	winfax.h

See also

DeleteDC

EndDoc

Fax Service Client API Structures

Fax Service Client API for Windows 2000

FaxPrintCoverPage

FaxStartPrintJob