Interface IFaxDoc (faxcom.h)

La double interface IFaxDoc est utilisée par une application cliente de télécopie pour transmettre des documents de télécopie et des pages de couverture. L’interface récupère et définit des informations sur les objets FaxDoc . Les informations incluent le nom du fichier à transmettre, le numéro de télécopie auquel le serveur de télécopie doit envoyer la télécopie, les paramètres de la page de garde et d’autres informations facultatives sur le destinataire et l’expéditeur de télécopie.

Héritage

L’interface IFaxDoc hérite de l’interface IDispatch . IFaxDoc a également les types de membres suivants :

Méthodes

L’interface IFaxDoc possède ces méthodes.

 
IFaxDoc ::get_BillingCode

Définit ou récupère la propriété BillingCode d’un objet FaxDoc. La propriété BillingCode est une chaîne terminée par null qui contient un code de facturation facultatif qui s’applique à la transmission de télécopie. (Obtenir)
IFaxDoc ::get_CoverpageName

Définit ou récupère la propriété CoverpageName pour un objet FaxDoc. La propriété CoverpageName est une chaîne terminée par null qui contient le nom du fichier de modèle de page de couverture (.csv) associé à l’objet. (Obtenir)
IFaxDoc ::get_CoverpageNote

Définit ou récupère la propriété CoverpageNote d’un objet FaxDoc. La propriété CoverpageNote est une chaîne terminée par null qui contient le texte d’un message ou d’une note de l’expéditeur qui se rapporte à la transmission de télécopie. (Obtenir)
IFaxDoc ::get_CoverpageSubject

Définit ou récupère la propriété CoverpageSubject d’un objet FaxDoc. La propriété CoverpageSubject est une chaîne terminée par null qui contient la ligne d’objet de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_DiscountSend

Définit ou récupère la propriété DiscountSend d’un objet FaxDoc. La propriété DiscountSend est une valeur booléenne qui indique si le serveur de télécopie transmet des télécopies pendant la période de remise. (Obtenir)
IFaxDoc ::get_DisplayName

Définit ou récupère la propriété DisplayName d’un objet FaxDoc. La propriété DisplayName est une chaîne null qui contient le nom à associer au document de télécopie. (Obtenir)
IFaxDoc ::get_EmailAddress

Définit ou récupère la propriété EmailAddress d’un objet FaxDoc. La propriété EmailAddress est une chaîne terminée par null qui contient l’adresse e-mail de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_FaxNumber

Définit ou récupère la propriété FaxNumber d’un objet FaxDoc. La propriété FaxNumber est une chaîne terminée par null qui contient le numéro de télécopie auquel le serveur de télécopie envoie la transmission de télécopie. (Obtenir)
IFaxDoc ::get_FileName

Définit ou récupère la propriété FileName pour un objet FaxDoc. La propriété FileName est une chaîne terminée par null qui contient le nom du fichier de document associé à l’objet. (Obtenir)
IFaxDoc ::get_RecipientAddress

Définit ou récupère la propriété RecipientAddress d’un objet FaxDoc. La propriété RecipientAddress est une chaîne terminée par null qui contient l’adresse postale du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientCity

Définit ou récupère la propriété RecipientCity d’un objet FaxDoc. La propriété RecipientCity est une chaîne terminée par null qui contient le nom de ville du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientCompany

Définit ou récupère la propriété RecipientCompany d’un objet FaxDoc. La propriété RecipientCompany est une chaîne terminée par null qui contient le nom de l’entreprise du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientCountry

Définit ou récupère la propriété RecipientCountry d’un objet FaxDoc. La propriété RecipientCountry est une chaîne terminée par null qui contient le pays/la région du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientDepartment

Définit ou récupère la propriété RecipientDepartment d’un objet FaxDoc. La propriété RecipientDepartment est une chaîne terminée par null qui contient le service du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientHomePhone

Définit ou récupère la propriété RecipientHomePhone d’un objet FaxDoc. La propriété RecipientHomePhone est une chaîne null qui contient le numéro de téléphone du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientName

Définit ou récupère la propriété RecipientName d’un objet FaxDoc. La propriété RecipientName est une chaîne terminée par null qui contient le nom du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientOffice

Définit ou récupère la propriété RecipientOffice d’un objet FaxDoc. La propriété RecipientOffice est une chaîne terminée par null qui contient le bureau du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientOfficePhone

Définit ou récupère la propriété RecipientOfficePhone d’un objet FaxDoc. La propriété RecipientOfficePhone est une chaîne terminée par null qui contient le numéro de téléphone du bureau du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientState

Définit ou récupère la propriété RecipientState d’un objet FaxDoc. La propriété RecipientState est une chaîne terminée par null qui contient l’état du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientTitle

Définit ou récupère la propriété RecipientTitle d’un objet FaxDoc. La propriété RecipientTitle est une chaîne terminée par null qui contient le titre du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_RecipientZip

Définit ou récupère la propriété RecipientZip d’un objet FaxDoc. La propriété RecipientZip est une chaîne terminée par null qui contient le code postal du destinataire de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SendCoverpage

Définit ou récupère la propriété SendCoverpage pour un objet FaxDoc. La propriété SendCoverpage est une valeur booléenne qui indique si le fichier de page de garde spécifié est stocké sur le serveur de télécopie. (Obtenir)
IFaxDoc ::get_SenderAddress

Définit ou récupère la propriété SenderAddress d’un objet FaxDoc. La propriété SenderAddress est une chaîne terminée par null qui contient l’adresse postale de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SenderCompany

Définit ou récupère la propriété SenderCompany d’un objet FaxDoc. La propriété SenderCompany est une chaîne terminée par null qui contient le nom de l’entreprise de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SenderDepartment

Définit ou récupère la propriété SenderDepartment d’un objet FaxDoc. La propriété SenderDepartment est une chaîne terminée par null qui contient le service de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SenderFax

Définit ou récupère la propriété SenderFax d’un objet FaxDoc. La propriété SenderFax est une chaîne terminée par null qui contient le numéro de télécopie de l’expéditeur de la transmission de télécopie sortante. (Obtenir)
IFaxDoc ::get_SenderHomePhone

Définit ou récupère la propriété SenderHomePhone d’un objet FaxDoc. La propriété SenderHomePhone est une chaîne terminée par null qui contient le numéro de téléphone de domicile de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SenderName

Définit ou récupère la propriété SenderName d’un objet FaxDoc. La propriété SenderName est une chaîne terminée par null qui contient le nom de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SenderOffice

Définit ou récupère la propriété SenderOffice d’un objet FaxDoc. La propriété SenderOffice est une chaîne terminée par null qui contient le bureau de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SenderOfficePhone

Définit ou récupère la propriété SenderOfficePhone d’un objet FaxDoc. La propriété SenderOfficePhone est une chaîne terminée par null qui contient le numéro de téléphone du bureau de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_SenderTitle

Définit ou récupère la propriété SenderTitle d’un objet FaxDoc. La propriété SenderTitle est une chaîne terminée par null qui contient le titre de l’expéditeur de la transmission de télécopie. (Obtenir)
IFaxDoc ::get_ServerCoverpage

Définit ou récupère la propriété ServerCoverpage pour un objet FaxDoc. La propriété ServerCoverpage est une valeur booléenne qui indique si le fichier de page de garde spécifié est stocké sur le serveur de télécopie. (Obtenir)
IFaxDoc ::get_Tsid

Définit ou récupère la propriété Tsid d’un objet FaxDoc. La propriété Tsid est une chaîne terminée par null qui contient un identificateur de station de transmission (TSID) défini par l’utilisateur. (Obtenir)
IFaxDoc ::p ut_BillingCode

Définit ou récupère la propriété BillingCode d’un objet FaxDoc. La propriété BillingCode est une chaîne terminée par null qui contient un code de facturation facultatif qui s’applique à la transmission de télécopie. (Put)
IFaxDoc ::p ut_CoverpageName

Définit ou récupère la propriété CoverpageName pour un objet FaxDoc. La propriété CoverpageName est une chaîne terminée par null qui contient le nom du fichier de modèle de page de couverture (.csv) associé à l’objet. (Put)
IFaxDoc ::p ut_CoverpageNote

Définit ou récupère la propriété CoverpageNote d’un objet FaxDoc. La propriété CoverpageNote est une chaîne terminée par null qui contient le texte d’un message ou d’une note de l’expéditeur qui se rapporte à la transmission de télécopie. (Put)
IFaxDoc ::p ut_CoverpageSubject

Définit ou récupère la propriété CoverpageSubject d’un objet FaxDoc. La propriété CoverpageSubject est une chaîne terminée par null qui contient la ligne d’objet de la transmission de télécopie. (Put)
IFaxDoc ::p ut_DiscountSend

Définit ou récupère la propriété DiscountSend d’un objet FaxDoc. La propriété DiscountSend est une valeur booléenne qui indique si le serveur de télécopie transmet des télécopies pendant la période de remise. (Put)
IFaxDoc ::p ut_DisplayName

Définit ou récupère la propriété DisplayName d’un objet FaxDoc. La propriété DisplayName est une chaîne null qui contient le nom à associer au document de télécopie. (Put)
IFaxDoc ::p ut_EmailAddress

Définit ou récupère la propriété EmailAddress d’un objet FaxDoc. La propriété EmailAddress est une chaîne terminée par null qui contient l’adresse e-mail de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_FaxNumber

Définit ou récupère la propriété FaxNumber d’un objet FaxDoc. La propriété FaxNumber est une chaîne terminée par null qui contient le numéro de télécopie auquel le serveur de télécopie envoie la transmission de télécopie. (Put)
IFaxDoc ::p ut_FileName

Définit ou récupère la propriété FileName pour un objet FaxDoc. La propriété FileName est une chaîne terminée par null qui contient le nom du fichier de document associé à l’objet. (Put)
IFaxDoc ::p ut_RecipientAddress

Définit ou récupère la propriété RecipientAddress d’un objet FaxDoc. La propriété RecipientAddress est une chaîne terminée par null qui contient l’adresse postale du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientCity

Définit ou récupère la propriété RecipientCity d’un objet FaxDoc. La propriété RecipientCity est une chaîne terminée par null qui contient le nom de ville du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientCompany

Définit ou récupère la propriété RecipientCompany d’un objet FaxDoc. La propriété RecipientCompany est une chaîne terminée par null qui contient le nom de l’entreprise du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientCountry

Définit ou récupère la propriété RecipientCountry d’un objet FaxDoc. La propriété RecipientCountry est une chaîne terminée par null qui contient le pays/la région du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientDepartment

Définit ou récupère la propriété RecipientDepartment d’un objet FaxDoc. La propriété RecipientDepartment est une chaîne terminée par null qui contient le service du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientHomePhone

Définit ou récupère la propriété RecipientHomePhone d’un objet FaxDoc. La propriété RecipientHomePhone est une chaîne null qui contient le numéro de téléphone du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientName

Définit ou récupère la propriété RecipientName d’un objet FaxDoc. La propriété RecipientName est une chaîne terminée par null qui contient le nom du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientOffice

Définit ou récupère la propriété RecipientOffice d’un objet FaxDoc. La propriété RecipientOffice est une chaîne terminée par null qui contient le bureau du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientOfficePhone

Définit ou récupère la propriété RecipientOfficePhone d’un objet FaxDoc. La propriété RecipientOfficePhone est une chaîne terminée par null qui contient le numéro de téléphone du bureau du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientState

Définit ou récupère la propriété RecipientState d’un objet FaxDoc. La propriété RecipientState est une chaîne terminée par null qui contient l’état du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientTitle

Définit ou récupère la propriété RecipientTitle d’un objet FaxDoc. La propriété RecipientTitle est une chaîne terminée par null qui contient le titre du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_RecipientZip

Définit ou récupère la propriété RecipientZip d’un objet FaxDoc. La propriété RecipientZip est une chaîne terminée par null qui contient le code postal du destinataire de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SendCoverpage

Définit ou récupère la propriété SendCoverpage pour un objet FaxDoc. La propriété SendCoverpage est une valeur booléenne qui indique si le fichier de page de garde spécifié est stocké sur le serveur de télécopie. (Put)
IFaxDoc ::p ut_SenderAddress

Définit ou récupère la propriété SenderAddress d’un objet FaxDoc. La propriété SenderAddress est une chaîne terminée par null qui contient l’adresse postale de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SenderCompany

Définit ou récupère la propriété SenderCompany d’un objet FaxDoc. La propriété SenderCompany est une chaîne terminée par null qui contient le nom de l’entreprise de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SenderDepartment

Définit ou récupère la propriété SenderDepartment d’un objet FaxDoc. La propriété SenderDepartment est une chaîne terminée par null qui contient le service de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SenderFax

Définit ou récupère la propriété SenderFax d’un objet FaxDoc. La propriété SenderFax est une chaîne terminée par null qui contient le numéro de télécopie de l’expéditeur de la transmission de télécopie sortante. (Put)
IFaxDoc ::p ut_SenderHomePhone

Définit ou récupère la propriété SenderHomePhone d’un objet FaxDoc. La propriété SenderHomePhone est une chaîne terminée par null qui contient le numéro de téléphone de domicile de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SenderName

Définit ou récupère la propriété SenderName d’un objet FaxDoc. La propriété SenderName est une chaîne terminée par null qui contient le nom de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SenderOffice

Définit ou récupère la propriété SenderOffice d’un objet FaxDoc. La propriété SenderOffice est une chaîne terminée par null qui contient le bureau de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SenderOfficePhone

Définit ou récupère la propriété SenderOfficePhone d’un objet FaxDoc. La propriété SenderOfficePhone est une chaîne terminée par null qui contient le numéro de téléphone du bureau de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_SenderTitle

Définit ou récupère la propriété SenderTitle d’un objet FaxDoc. La propriété SenderTitle est une chaîne terminée par null qui contient le titre de l’expéditeur de la transmission de télécopie. (Put)
IFaxDoc ::p ut_ServerCoverpage

Définit ou récupère la propriété ServerCoverpage pour un objet FaxDoc. La propriété ServerCoverpage est une valeur booléenne qui indique si le fichier de page de garde spécifié est stocké sur le serveur de télécopie. (Put)
IFaxDoc ::p ut_Tsid

Définit ou récupère la propriété Tsid d’un objet FaxDoc. La propriété Tsid est une chaîne terminée par null qui contient un identificateur de station de transmission (TSID) défini par l’utilisateur. (Put)
IFaxDoc ::Send

La méthode Send transmet le document spécifié par la propriété FileName d’un objet FaxDoc. La méthode peut envoyer la télécopie au numéro de télécopie spécifié par la propriété FaxNumber.

Remarques

L’interface IFaxDoc comprend les méthodes suivantes :

  • Méthode permettant d’envoyer un document de télécopie.
  • Méthodes de propriété pour définir et récupérer des valeurs de propriété individuelles associées à un objet FaxDoc .

Quand implémenter

Vous ne devez pas implémenter cette interface. L’implémentation standard de Microsoft fournit des fonctionnalités complètes.

Quand utiliser

Utilisez l’interface IFaxDoc pour envoyer un document de télécopie. Vous pouvez également utiliser l’interface IFaxDoc pour récupérer et définir les propriétés d’un objet FaxDoc .

Une application cliente ne doit pas appeler la fonction CoCreateInstance pour récupérer un pointeur d’interface IFaxDoc . Au lieu de cela, l’application doit effectuer les étapes suivantes pour créer un instance d’un objet FaxDoc :

  1. Appelez la fonction CoCreateInstance pour récupérer un pointeur vers une interface IFaxServer .
  2. Appelez la méthode IFaxServer ::Connect pour vous connecter à un serveur de télécopie actif.
  3. Appelez la méthode IFaxServer ::CreateDocument pour créer et initialiser un objet FaxDoc pour le serveur de télécopie connecté. (Après avoir appelé la méthode IFaxServer ::CreateDocument , vous pouvez également appeler la méthode IUnknown ::QueryInterface pour récupérer un pointeur d’interface IFaxDoc .)
  4. Utilisez le pointeur d’interface IDispatch pour appeler les méthodes d’interface IFaxDoc .
  5. Appelez la méthode IFaxServer ::D isconnect pour vous déconnecter du serveur de télécopie.
  6. Appelez la méthode IUnknown ::Release pour détruire le pointeur d’interface IFaxDoc et le pointeur d’interface IFaxServer parent.
Les méthodes de propriété de l’interface IFaxDoc obtiennent ou définissent les propriétés décrites ci-dessous. Si la propriété prend en charge l’accès en lecture, l’interface IFaxDoc inclut une méthode get_PropertyName . Si la propriété prend en charge l’accès en écriture, l’interface inclut une méthode put_PropertyName .

Les valeurs ne sont pas requises pour les propriétés facultatives qui s’affichent uniquement sur la page de couverture. La propriété FileName est requise pour envoyer une transmission de télécopie à l’aide d’un appel à la méthode IFaxDoc ::Send . La propriété FaxNumber est également requise.

Le serveur de télécopie peut fournir des données à partir du Registre pour de nombreuses propriétés qui commencent par Sender. Le serveur de télécopie fournit des valeurs si elles ont été entrées sous l’onglet Informations utilisateur accessible via l’icône Télécopie dans Panneau de configuration.

Voici les propriétés associées à un objet FaxDoc .

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête faxcom.h

Voir aussi

Interfaces de l’API cliente du service de télécopie

API cliente du service de télécopie pour Windows 2000

IDispatch