IFaxStatus::get_DocumentName method (faxcom.h)
Retrieves the DocumentName property for the FaxStatus object of a parent FaxPort object. The DocumentName property is a null-terminated string that contains the user-friendly name associated with an active fax document.
This property is read-only.
Syntax
HRESULT get_DocumentName(
BSTR *pVal
);
Parameters
pVal
Return value
None
Remarks
You can use the DocumentName property of a FaxStatus object in conjunction with the DocumentSize property of the object to inform users about the size of outbound jobs.
The IFaxStatus::get_DocumentName method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | faxcom.h |
| DLL | Faxcom.dll |
See also
Fax Service Client API Interfaces