home *** CD-ROM | disk | FTP | other *** search
/ IBM CD Showcase / OS2_CD_ROM.iso / smce0001 / faxpm / demo / api0 / FAXAPI.INF (.txt) < prev    next >
Encoding:
OS/2 Help File  |  1993-11-10  |  160.7 KB  |  7,426 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. Read this first ΓòÉΓòÉΓòÉ
  3.  
  4. The Fax/PM APIs are included in the Fax/PM 2.0 full product. 
  5.  
  6. The Fax/PM API OnLine Reference is provided for information purposes. 
  7.  
  8. Microformatic hope this will be useful for easier Fax integration. 
  9.  
  10. Fax/PM APIs are written in SOM and can be directly accessed from any language 
  11. for which SOM bindings are available, and from REXX applications. 
  12.  
  13. For any technical information, please contact Microformatic : 
  14.  
  15. Phone               33 (1) 48.70.19.00 
  16. Fax                 33 (1) 48.70.27.29 
  17. CompuServe ID       100024,1777 
  18.  
  19.  
  20. ΓòÉΓòÉΓòÉ 2. Related information ΓòÉΓòÉΓòÉ
  21.  
  22. This section contains further information about how to use the Fax/PM API. 
  23.  
  24.  
  25. ΓòÉΓòÉΓòÉ 2.1. Copyright ΓòÉΓòÉΓòÉ
  26.  
  27. EVALUATION AND VERIFICATION OF OPERATION IN CONJUNCTION WITH OTHER PRODUCTS, 
  28. PROGRAMS, OR SERVICES, EXCEPT THOSE EXPRESSLY DESIGNATED BY MICROFORMATIC, ARE 
  29. USER'S RESPONSABILITY. 
  30.  
  31. MICROFORMATIC MAY HAVE PATENTS OR PENDING PATENT APPLICATIONS COVERING SUBJECT 
  32. MATTER IN THIS DOCUMENT. 
  33.  
  34. MICROFORMATIC PROVIDES THIS DOCUMENTATION "AS IS" WITHOUT WARRANTY OF ANY KIND. 
  35.  
  36. (c) Microformatic 1990, 1993. All rigths reserved 
  37.  
  38.  
  39. ΓòÉΓòÉΓòÉ 2.2. Include files ΓòÉΓòÉΓòÉ
  40.  
  41. The include files that are necessary for the Fax/PM API are the following : 
  42.  
  43. group.h 
  44. recip.h 
  45. faxapi.h 
  46. *.SC files 
  47.  
  48. This files are located in the subdirectory API, created in the directory where 
  49. Fax/PM is installed. 
  50.  
  51.  
  52. ΓòÉΓòÉΓòÉ <hidden> group.h ΓòÉΓòÉΓòÉ
  53.  
  54. This include contains the definitions for the FaxGroup class. 
  55.  
  56. (c) Microformatic S.A - 1993 
  57.  
  58.  
  59. ΓòÉΓòÉΓòÉ <hidden> recip.h ΓòÉΓòÉΓòÉ
  60.  
  61. This include contains the definitions for the FaxRecipient class. 
  62.  
  63. (c) Microformatic S.A - 1993 
  64.  
  65.  
  66. ΓòÉΓòÉΓòÉ <hidden> FAXAPI.h ΓòÉΓòÉΓòÉ
  67.  
  68. This include contains the definitions to use the Printer Driver interface. 
  69.  
  70. (c) Microformatic S.A - 1993 
  71.  
  72.  
  73. ΓòÉΓòÉΓòÉ 2.3. Sample ΓòÉΓòÉΓòÉ
  74.  
  75. A SAMPLE subdirectory is created at install time. This subdirectory contains 
  76. the following files : 
  77.  
  78. sample.c 
  79. sample.def 
  80. makefile 
  81.  
  82. To compile this sample, you must first define the following environment 
  83. variables : 
  84.  
  85. INCLUDE 
  86. LIB 
  87. PATH 
  88.  
  89.  
  90. ΓòÉΓòÉΓòÉ <hidden> makefile ΓòÉΓòÉΓòÉ
  91.  
  92. This is the makefile used to build the sample : 
  93.  
  94. #*****************************************************************************
  95. #*
  96. #* File         MAKEFILE
  97. #*
  98. #* Build        SAMPLE┬╖EXE
  99. #*
  100. #* Last modif   February 5, 1993
  101. #*
  102. #* Copyright    (c) Microformatic S┬╖A┬╖ 1993
  103. #*
  104. #*****************************************************************************/
  105.  
  106.  
  107. #*****************************************************************************
  108. #* Suffixes
  109. #*****************************************************************************/
  110.  
  111. ┬╖SUFFIXES: ┬╖c ┬╖rc ┬╖obj ┬╖res ┬╖bin ┬╖exe
  112.  
  113.  
  114. #*****************************************************************************
  115. #* Standard options
  116. #*****************************************************************************/
  117.  
  118. COPTS = /Fd /Ss /Q /W1 /Gm /Gd /C
  119. LOPTS = /BAT /LI /M:FULL /NOI /NOL /NOD /NOE
  120.  
  121.  
  122. #*****************************************************************************
  123. #* Tools
  124. #*****************************************************************************/
  125.  
  126. COMPILE = ICC
  127. LINK = LINK386
  128.  
  129.  
  130. #*****************************************************************************
  131. #* Debug options
  132. #*****************************************************************************/
  133.  
  134. !IFDEF NODEBUG
  135. CDEBUGOPTS =
  136. LDEBUGOPTS =
  137. !ELSE
  138. CDEBUGOPTS = /Ti
  139. LDEBUGOPTS = /CO
  140. !ENDIF
  141.  
  142.  
  143. #*****************************************************************************
  144. #* Main target
  145. #*****************************************************************************/
  146.  
  147. all: sample┬╖exe
  148.  
  149.  
  150. #*****************************************************************************
  151. #* Dependencies
  152. #*****************************************************************************/
  153.  
  154. sample┬╖exe:                                                       \
  155.   sample┬╖obj                                                      \
  156.   sample┬╖def
  157.    @REM @<<sample┬╖@0
  158.      sample┬╖obj
  159.      sample┬╖exe
  160.  
  161.      DDE4MBSO FAXAPP12 OS2386 SOM FAXGRP1 FAXRCP1
  162.      sample┬╖def;
  163. <<
  164.    $(LINK) $(LDEBUGOPTS) $(LOPTS) @sample┬╖@0
  165.  
  166.  
  167. #*****************************************************************************
  168. #* Implicit rules
  169. #*****************************************************************************/
  170.  
  171. {┬╖}┬╖c┬╖obj:
  172.    $(COMPILE) $(CDEBUGOPTS) $(CMACROS) $(COPTS) ┬╖\$*┬╖c
  173.  
  174.  
  175. #*****************************************************************************
  176. #* Other dependencies
  177. #*****************************************************************************/
  178.  
  179. sample┬╖obj:  sample┬╖c
  180.  
  181.  
  182. ΓòÉΓòÉΓòÉ <hidden> sample.c ΓòÉΓòÉΓòÉ
  183.  
  184. This is the sample code. 
  185.  
  186. /*****************************************************************************
  187. /*
  188. /* File         SAMPLE.C
  189. /*
  190. /* Program      Sample for Fax/PM API use.
  191. /*
  192. /* Last modif   February 5, 1993
  193. /*
  194. /* Copyright    (c) Microformatic S.A. 1993
  195. /*
  196. /*****************************************************************************/
  197.  
  198. /*****************************************************************************
  199. /* Includes
  200. /*****************************************************************************/
  201.  
  202. #define INCL_DOS
  203. #define INCL_ERROR
  204. #define INCL_ERRORS
  205. #define INCL_PM
  206. #include <os2.h>
  207. #include <stdlib.h>
  208. #include <stdio.h>
  209. #include <string.h>
  210. #include <memory.h>
  211.  
  212. #include <recip.h>
  213. #include <group.h>
  214.  
  215. /*****************************************************************************
  216. /* Includes
  217. /*****************************************************************************/
  218.  
  219. #define MAX    10
  220. #define GROUP_NAME    "All names"
  221. #define NEW_GROUP_NAME    "New All names"
  222.  
  223.  
  224. /*****************************************************************************
  225. /* Global variables
  226. /*****************************************************************************/
  227.  
  228. FaxRecipient *MyPhoneBook;
  229. FaxGroup * MyGroup;
  230.  
  231. CHAR szArg[512];
  232. CHAR szArg1[80];
  233. CHAR szArg2[80];
  234.  
  235.  
  236. /*****************************************************************************
  237. /*
  238. /* Function     LISTALL
  239. /*
  240. /* Description  Lists the names and groups defined in the Fax/PM phone book.
  241. /*
  242. /* Parameters   none
  243. /*
  244. /* Return code  none
  245. /*
  246. /****************************************************************************/
  247.  
  248. VOID APIENTRY  LISTALL()
  249. {
  250.    APIRET rc;                         /* return code for function calls      */
  251.    ULONG ulLen;                       /* length of required memory           */
  252.    PSZ pszGroups;                     /* pointer to group list               */
  253.    PSZ pszNames;                      /* pointer to name list                */
  254.    ULONG i ;                          /* index in a list                     */
  255.  
  256.   /***************************************************************************
  257.   /* List all groups : issue a first call to get the length of the required
  258.   /* memory, then issue a second call to actually retrieve the information.
  259.   /**************************************************************************/
  260.    rc = FaxGroup_GetAllNames(MyGroup, (PSZ) 0, &ulLen);
  261.    if (rc != FAX_PHONEBOOK_OK) {
  262.       ulLen=0 ;
  263.    };
  264.    printf("-----------------------> Groups in Fax/PM phone book :\n");
  265.    if (ulLen != 0) {
  266.       pszGroups = (PSZ) malloc(ulLen);
  267.       rc = FaxGroup_GetAllNames(MyGroup, (PSZ) pszGroups, &ulLen);
  268.       if (rc != FAX_PHONEBOOK_OK) {
  269.          printf("LISTALL: GetAllNames rc: %d\n", rc);
  270.          free(pszGroups);
  271.          return;
  272.       };
  273.       for (i=0; pszGroups[i] != 0; ) {
  274.          printf("\t>>> %s\n", &pszGroups[i]);
  275.          i = i + strlen(&pszGroups[i]) + 1;
  276.       } /* endfor */
  277.    free(pszGroups);
  278.    } else {
  279.       printf("No group defined !\n");
  280.    }; /* endif */
  281.  
  282.  
  283.   /***************************************************************************
  284.   /* List all names : issue a first call to get the length of the required
  285.   /* memory, then issue a second call to actually retrieve the information.
  286.   /**************************************************************************/
  287.    rc = FaxRecipient_GetAllNames(MyPhoneBook, (PSZ) 0, &ulLen);
  288.    if (rc != FAX_PHONEBOOK_OK) {
  289.       ulLen=0 ;
  290.    };
  291.    printf("-----------------------> Names in Fax/PM phone book :\n");
  292.    if (ulLen != 0) {
  293.       pszNames = (PSZ) malloc(ulLen);
  294.       rc = FaxRecipient_GetAllNames(MyPhoneBook, (PSZ) pszNames, &ulLen);
  295.       if (rc != FAX_PHONEBOOK_OK) {
  296.          printf("LISTALL: GetAllRecipientNames rc: %d\n", rc);
  297.          free(pszNames);
  298.          return;
  299.       };
  300.       for (i=0; pszNames[i] != 0; ) {
  301.          printf("\t>>> %s\n", &pszNames[i]);
  302.          i = i + strlen(&pszNames[i]) + 1;
  303.       } /* endfor */
  304.    } else {
  305.       printf("No name defined !\n");
  306.       return;
  307.    }; /* endif */
  308.    printf("-----------------------> End of list\n");
  309.    free(pszNames);
  310.    return;
  311. }
  312.  
  313.  
  314. /*****************************************************************************
  315. /*
  316. /* Function     GO1
  317. /*
  318. /* Description  Process 1 parameter command line
  319. /*
  320. /* Parameters   none
  321. /*
  322. /* Return code  none
  323. /*
  324. /****************************************************************************/
  325.  
  326. VOID APIENTRY GO1()
  327. {
  328.    APIRET rc;                         /* return code for function calls      */
  329.    ULONG ulLen;                       /* length of required memory           */
  330.    ULONG i ;                          /* index in a list                     */
  331.    PSZ p1;                            /* parameter 1                         */
  332.    PSZ p2;                            /* parameter 2                         */
  333.  
  334.    p1 = (PSZ) 0;
  335.    p2 = (PSZ) 0;
  336.  
  337.   /***************************************************************************
  338.   /* Delete a group
  339.   /**************************************************************************/
  340.    p1 = strstr(szArg1, "-DN:");
  341.    if (p1 != (PSZ) 0) {
  342.       printf("Delete group name: %s\n", &p1[4]);
  343.       rc = FaxGroup_Delete(MyGroup, &p1[4]);
  344.       printf("Delete group name: %s rc:%ld\n", &p1[4], rc);
  345.       return;
  346.    };
  347.  
  348.   /***************************************************************************
  349.   /* Get a recipient from the phonebook
  350.   /**************************************************************************/
  351.    p1 = strstr(szArg1, "-LN:");
  352.    if (p1 != (PSZ) 0) {
  353.       rc = FaxRecipient_Get(MyPhoneBook, &p1[4]);
  354.       if (rc != FAX_PHONEBOOK_OK) {
  355.          printf("Get recipient: %s rc:%ld\n", &p1[4], rc);
  356.          return;
  357.       };
  358.       rc = FaxRecipient_GetTel(MyPhoneBook, (PSZ) 0, &ulLen);
  359.       if (rc != FAX_PHONEBOOK_OK) {
  360.          printf("Get fax phone number for: %s rc:%ld\n", &p1[4], rc);
  361.       };
  362.       p2 = (PSZ) malloc(ulLen);
  363.       rc = FaxRecipient_GetTel(MyPhoneBook, (PSZ) p2, &ulLen);
  364.       printf("Name: %s\nFax phone number: %s\n", &p1[4], p2);
  365.       free(p2);
  366.       return;
  367.    };
  368.  
  369.   /***************************************************************************
  370.   /* Get the list of recipients is a group
  371.   /**************************************************************************/
  372.    p1 = strstr(szArg1, "-LG:");
  373.    if (p1 != (PSZ) 0) {
  374.       rc = FaxGroup_GetGroupContents(MyGroup,
  375.                                          (PSZ) 0,
  376.                                          &ulLen,
  377.                                          &p1[4]);
  378.       if (rc == FAX_PHONEBOOK_GROUP_NOTFOUND) {
  379.          printf("Group: %s not found rc: %ld\n", &p1[4], rc);
  380.          return;
  381.       };
  382.       if (rc != FAX_PHONEBOOK_OK) {
  383.          printf("Group: %s not found error rc: %ld\n", &p1[4], rc);
  384.          return;
  385.       };
  386.       p2 = (PSZ) malloc(ulLen);
  387.       rc = FaxGroup_GetGroupContents(MyGroup,
  388.                                          (PSZ) p2,
  389.                                          &ulLen,
  390.                                          &p1[4]);
  391.       if (rc != FAX_PHONEBOOK_OK) {
  392.          printf("Group: %s not found error rc: %ld\n", &p1[4], rc);
  393.          return;
  394.       };
  395.       printf("Group: %s contents:\n", &p1[4]);
  396.       for (i=0; p2[i] != 0; ) {
  397.          printf("\t>>> %s\n", &p2[i]);
  398.          i = i + strlen(&p2[i]) + 1;
  399.       } /* endfor */
  400.       printf("end Group: %s contents:\n", &p1[4]);
  401.       free(p2);
  402.       return;
  403.    };
  404.  
  405.   /***************************************************************************
  406.   /* Delete a group
  407.   /**************************************************************************/
  408.    p1 = strstr(szArg1, "-DG:");
  409.    if (p1 != (PSZ) 0) {
  410.       rc = FaxGroup_Delete(MyGroup, &p1[4]);
  411.       if (rc == FAX_PHONEBOOK_GROUP_NOTFOUND) {
  412.          printf("Delete group: %s rc:%ld (Group unknown !)\n", &p1[4], rc);
  413.          return;
  414.       };
  415.       if (rc == FAX_PHONEBOOK_OK) {
  416.          printf("Delete group: %s error rc:%ld\n", &p1[4], rc);
  417.          return;
  418.       };
  419.       printf("Delete group: %s rc:%ld\n", &p1[4], rc);
  420.       return;
  421.    };
  422.  
  423.    return;
  424. }
  425.  
  426.  
  427. /*****************************************************************************
  428. /*
  429. /* Function     GO2
  430. /*
  431. /* Description  Process 2 parameters command line
  432. /*
  433. /* Parameters   none
  434. /*
  435. /* Return code  none
  436. /*
  437. /****************************************************************************/
  438.  
  439. VOID APIENTRY GO2()
  440. {
  441.    APIRET rc;                         /* return code for function calls      */
  442.    ULONG ulLen;                       /* length of required memory           */
  443.    PSZ p1;                            /* parameter 1                         */
  444.    PSZ p2;                            /* parameter 2                         */
  445.  
  446.   /***************************************************************************
  447.   /* Add recipient in the phonebook
  448.   /**************************************************************************/
  449.    p1 = strstr(szArg1, "-AN:");
  450.    if (p1 != (PSZ) 0) {
  451.       rc = FaxRecipient_SetName(MyPhoneBook, &p1[4]);
  452.       rc = FaxRecipient_SetTel(MyPhoneBook,  szArg2);
  453.       rc = FaxRecipient_Create(MyPhoneBook);
  454.       if (rc != FAX_PHONEBOOK_OK) {
  455.          printf("Add recipient name: %s error rc: %ld\n", &p1[4], rc);
  456.          return;
  457.       };
  458.       printf("Add recipient name: %s Ok\n", &p1[4]);
  459.       return;
  460.    };
  461.  
  462.   /***************************************************************************
  463.   /* Add recipient in a group
  464.   /**************************************************************************/
  465.    p1 = strstr(szArg1, "-NG:");
  466.    if (p1 != (PSZ) 0) {
  467.       rc = FaxGroup_AddName(MyGroup, szArg2, &p1[4]);
  468.       if (rc != FAX_PHONEBOOK_OK) {
  469.          printf("Add recipient %s to group: %s error rc: %ld", &p1[4], szArg2, rc);
  470.          return;
  471.       };
  472.       printf("Add recipient %s to group: %s Ok\n", &p1[4], szArg2);
  473.       return;
  474.    };
  475.  
  476.   /***************************************************************************
  477.   /* Update recipient
  478.   /**************************************************************************/
  479.    p1 = strstr(szArg1, "-UN:");
  480.    if (p1 != (PSZ) 0) {
  481.       rc = FaxRecipient_SetName(MyPhoneBook, &p1[4]);
  482.       rc = FaxRecipient_SetTel(MyPhoneBook,  szArg2);
  483.       rc = FaxRecipient_Update(MyPhoneBook);
  484.       if (rc != FAX_PHONEBOOK_OK) {
  485.          printf("Update recipient name: %s error rc: %ld\n", &p1[4], rc);
  486.          return;
  487.       };
  488.       printf("Update recipient name: %s Ok\n", &p1[4]);
  489.       return;
  490.    };
  491.  
  492.   /***************************************************************************
  493.   /* Delete name from a group
  494.   /**************************************************************************/
  495.    p1 = strstr(szArg1, "-SG:");
  496.    if (p1 != (PSZ) 0) {
  497.       rc = FaxGroup_DeleteName(MyGroup, szArg2, &p1[4]);
  498.       if (rc == FAX_PHONEBOOK_GROUP_NOTFOUND) {
  499.          printf("Delete recipient: %s in group: %s, group not found\n", &p1[4], szArg2);
  500.          return;
  501.       };
  502.       if (rc != FAX_PHONEBOOK_OK) {
  503.          printf("Delete recipient: %s in group: %s error rc:%ld\n", &p1[4], szArg2, rc);
  504.          return;
  505.       };
  506.       printf("Delete recipient: %s in group: %s Ok\n", &p1[4], szArg2);
  507.       return;
  508.    };
  509.  
  510.  
  511.    return;
  512. }
  513.  
  514. /*****************************************************************************
  515. /*
  516. /* Function     main
  517. /*
  518. /* Description  main function : check parameters and take appropriate action.
  519. /*
  520. /* Parameters   int argc : arguments count
  521. /*              char * argv[] : array of string pointers
  522. /*
  523. /* Return code  0
  524. /*
  525. /****************************************************************************/
  526.  
  527. int _Optlink main ( int argc, char* argv [] ) {
  528.  
  529.   /***************************************************************************
  530.   /* Initialize all the objects
  531.   /**************************************************************************/
  532.    FaxRecipientNewClass(0,0);
  533.    FaxGroupNewClass(0,0);
  534.    MyPhoneBook = _somNew(_FaxRecipient);
  535.    if (MyPhoneBook == 0) {
  536.       printf("ERROR : Recipient Creation failed");
  537.       return 0  ;
  538.    };
  539.    MyGroup = _somNew(_FaxGroup);
  540.    if (MyGroup == 0) {
  541.       printf("ERROR : Group Creation failed");
  542.       return 0  ;
  543.    };
  544.    FaxRecipient_Setup(MyPhoneBook, "");
  545.    FaxGroup_Setup(MyGroup, "");
  546.  
  547.   /***************************************************************************
  548.   /* No argument : print command line syntax
  549.   /**************************************************************************/
  550.    if (argc == 1) {
  551.       printf("Fax/PM API Sample Program - (c) Microformatic 1993\n\n") ;
  552.       printf("Syntax :\n");
  553.       printf("      commands used on Recipient names\n");
  554.       printf("         -DN:name                      : delete a name\n");
  555.       printf("         -AN:name phone                : add name & phone\n");
  556.       printf("         -LN:name                      : list a name\n");
  557.       printf("         -NG:name group                : add a name to group\n");
  558.       printf("         -UN:name phone                : update a name & phone\n");
  559.       printf("\n");
  560.       printf("      commands used on Group names\n");
  561.       printf("         -LG:group                     : list a group contents\n");
  562.       printf("         -DG:group                     : delete a group\n");
  563.       printf("         -SG:name group                : supress a name in a group\n");
  564.       printf("\n");
  565.       printf("      no parameters                    : list all groups & names\n");
  566.       printf("\n");
  567.       printf("\n");
  568.    };
  569.  
  570.   /***************************************************************************
  571.   /* Take the action depending on the number of parameters
  572.   /**************************************************************************/
  573.    szArg[0] = 0;
  574.    if (argc == 1) {
  575.       LISTALL();
  576.    } else {
  577.       if (argc == 2) {
  578.          strcpy(szArg1, argv[1]);
  579.          GO1();
  580.       } else {
  581.          strcpy(szArg1, argv[1]);
  582.          strcpy(szArg2, argv[2]);
  583.          GO2();
  584.       }; /* endif */
  585.    }; /* endif */
  586.  
  587.    return 0 ;
  588. }
  589.  
  590.  
  591. ΓòÉΓòÉΓòÉ <hidden> *.SC files ΓòÉΓòÉΓòÉ
  592.  
  593. These files must be included if you want to create SOM classes that inherit 
  594. from the Fax/PM defined classes. These files are : 
  595.  
  596. recip.sc : the FaxRecipient class definition. 
  597. group.sc : the FaxGroup class definition. 
  598. faxjob1.sc : the FaxJob class definition. 
  599. faxhdr1.sc : the FaxJobHeader class definition. 
  600.  
  601.  
  602. ΓòÉΓòÉΓòÉ <hidden> sample.def ΓòÉΓòÉΓòÉ
  603.  
  604. This is the sample module definition file. 
  605.  
  606. ;*****************************************************************************
  607. ;*
  608. ;* File         SAMPLE.DEF
  609. ;*
  610. ;* Program      Module definition file for Fax/PM API sample
  611. ;*
  612. ;* Last modif   February 5, 1993
  613. ;*
  614. ;* Copyright    (c) Microformatic S.A. 1993
  615. ;*
  616. ;*****************************************************************************/
  617.  
  618. Name Sample NotWindowCompat
  619.  
  620. Description 'Sample program for Fax/PM API - (c) Microformatic 1993'
  621.  
  622. Stacksize 10240
  623.  
  624.  
  625. ΓòÉΓòÉΓòÉ 2.4. Libraries ΓòÉΓòÉΓòÉ
  626.  
  627. To link your programs that use the Fax/PM API, you have to use the following 
  628. libraries : 
  629.  
  630. faxgrp1.lib 
  631. faxrcp1.lib 
  632. faxjob1.lib 
  633. faxapp12.lib 
  634.  
  635. This files are located in the subdirectory API, created in the directory where 
  636. Fax/PM is installed. 
  637.  
  638. Some other libraries are required, from the OS/2 toolkit. These libraries are : 
  639.  
  640. dde4mbso : runtime linking 
  641. os2386.lib : OS/2 system functions 
  642. som.lib : som functions 
  643.  
  644. Note:  It is recommended to compile your source programs using the dynamic 
  645. linking to libraries option. This is why the DDE4MBSO library is useful. 
  646.  
  647.  
  648. ΓòÉΓòÉΓòÉ 3. Faxjob Class ΓòÉΓòÉΓòÉ
  649.  
  650. The FaxJob class allows you to manage Fax/PM Send Requests. 
  651.  
  652.  
  653. ΓòÉΓòÉΓòÉ 3.1. Get ΓòÉΓòÉΓòÉ
  654.  
  655. Function Syntax 
  656. Parameters 
  657. Return Values 
  658. Notes 
  659. Usage 
  660. Related methods 
  661.  
  662.  
  663. ΓòÉΓòÉΓòÉ <hidden> Get - Function Syntax ΓòÉΓòÉΓòÉ
  664.  
  665. /***********************************
  666. /* The Get method is used to load
  667. /* an existing job
  668. /***********************************
  669.  
  670. APIRET rc ;
  671. FaxJob * self ;
  672. ULONG ulJobNumber;
  673.  
  674. rc = FaxJob_Get ( self, ulJobNumber) ;
  675.  
  676.  
  677. ΓòÉΓòÉΓòÉ <hidden> Get - Parameters ΓòÉΓòÉΓòÉ
  678.  
  679.  self (FaxJob *) - input 
  680.      Fax job object 
  681.  
  682.  ulJobNumber (PSZ) - input 
  683.      number of the job to load. 
  684.  
  685.  
  686. ΓòÉΓòÉΓòÉ <hidden> Get - Return Values ΓòÉΓòÉΓòÉ
  687.  
  688. The possible return values are the following : 
  689.  
  690.  FAX_JOB_OK 
  691.  FAX_JOBERR_NOSETUP 
  692.  FAX_JOBERR_BADJOBNUMBER 
  693.  FAX_JOBERR_MEMORYALLOCFAILED 
  694.  FAX_JOBERR_BADUSERNAME 
  695.  
  696.  
  697. ΓòÉΓòÉΓòÉ <hidden> Get - Notes ΓòÉΓòÉΓòÉ
  698.  
  699. This method is used to load an existing job. All the informations about the job 
  700. are stored in the job object. 
  701.  
  702.  
  703. ΓòÉΓòÉΓòÉ <hidden> Get - Usage ΓòÉΓòÉΓòÉ
  704.  
  705. Use this method to load an existing job. 
  706.  
  707.  
  708. ΓòÉΓòÉΓòÉ <hidden> Get - Related methods ΓòÉΓòÉΓòÉ
  709.  
  710.   Update 
  711.   Delete 
  712.  
  713.  
  714. ΓòÉΓòÉΓòÉ 3.2. Create ΓòÉΓòÉΓòÉ
  715.  
  716.  Function Syntax 
  717.  Parameters 
  718.  Return Values 
  719.  Notes 
  720.  Usage 
  721.  Related methods 
  722.  
  723.  
  724. ΓòÉΓòÉΓòÉ <hidden> Create - Function Syntax ΓòÉΓòÉΓòÉ
  725.  
  726. /*******************************
  727. /* The Create method is used
  728. /* to create a fax job
  729. /*******************************
  730.  
  731. APIRET rc ;
  732. FaxJob * self ;
  733. PULONG pulNewReqNumber;
  734.  
  735. rc = FaxJob_Create ( self, pulNewReqNumber) ;
  736.  
  737.  
  738. ΓòÉΓòÉΓòÉ <hidden> Create - Parameters ΓòÉΓòÉΓòÉ
  739.  
  740.  self (FaxJob *) - input 
  741.      Fax job object 
  742.  
  743.  pulNewReqNumber (PULONG) - output 
  744.      number of the created job . 
  745.  
  746.  
  747. ΓòÉΓòÉΓòÉ <hidden> Create - Return Values ΓòÉΓòÉΓòÉ
  748.  
  749. The possible return values are the following : 
  750.  
  751.  FAX_JOB_OK 
  752.  FAX_JOBERR_NOSETUP 
  753.  FAX_JOBERR_MEMORYALLOCFAILED 
  754.  FAX_JOBERR_CREATEFAILED 
  755.  FAX_JOBERR_BADSTATE 
  756.  
  757.  
  758. ΓòÉΓòÉΓòÉ <hidden> Create - Notes ΓòÉΓòÉΓòÉ
  759.  
  760. This method is used to create a new job using the informations stored in the 
  761. job object data.Use Set... functions to initialize job object data. It is not 
  762. necessary to set job number - it is set by Create method. 
  763.  
  764.  
  765. ΓòÉΓòÉΓòÉ <hidden> Create - Usage ΓòÉΓòÉΓòÉ
  766.  
  767. Use this method to create a new job. 
  768.  
  769.  
  770. ΓòÉΓòÉΓòÉ <hidden> Create - Related methods ΓòÉΓòÉΓòÉ
  771.  
  772.   Update 
  773.   Delete 
  774.  
  775.  
  776. ΓòÉΓòÉΓòÉ 3.3. Update ΓòÉΓòÉΓòÉ
  777.  
  778.  Function Syntax 
  779.  Parameters 
  780.  Return Values 
  781.  Notes 
  782.  Usage 
  783.  Related methods 
  784.  
  785.  
  786. ΓòÉΓòÉΓòÉ <hidden> Update - Function Syntax ΓòÉΓòÉΓòÉ
  787.  
  788. /*******************************************************
  789. /* The Update method is used to update a fax job
  790. /*******************************************************
  791.  
  792. APIRET rc ;
  793. FaxJob * self ;
  794.  
  795. rc = FaxJob_Update ( self ) ;
  796.  
  797.  
  798. ΓòÉΓòÉΓòÉ <hidden> Update - Parameters ΓòÉΓòÉΓòÉ
  799.  
  800.  self (FaxJob *) - input 
  801.      Fax job object 
  802.  
  803.  
  804. ΓòÉΓòÉΓòÉ <hidden> Update - Return Values ΓòÉΓòÉΓòÉ
  805.  
  806. The possible return values are the following : 
  807.  
  808.  FAX_JOB_OK 
  809.  FAX_JOBERR_NOSETUP 
  810.  FAX_JOBERR_MEMORYALLOCFAILED 
  811.  FAX_JOBERR_REQUESTNOTFOUND 
  812.  FAX_JOBERR_BADUSERNAME 
  813.  FAX_JOBERR_BADSTATE 
  814.  FAX_JOBERR_FILENAMECHANGED 
  815.  
  816.  
  817. ΓòÉΓòÉΓòÉ <hidden> Update - Notes ΓòÉΓòÉΓòÉ
  818.  
  819. This method is used to update an existing job using the informations stored in 
  820. the job object data.Use Get... function to load the job and Set... functions to 
  821. update it. Thus call Update method to save the changes. 
  822.  
  823.  
  824. ΓòÉΓòÉΓòÉ <hidden> Update - Usage ΓòÉΓòÉΓòÉ
  825.  
  826. Use this method to update an existing job. 
  827.  
  828.  
  829. ΓòÉΓòÉΓòÉ <hidden> Update - Related methods ΓòÉΓòÉΓòÉ
  830.  
  831.   Get 
  832.   Delete 
  833.  
  834.  
  835. ΓòÉΓòÉΓòÉ 3.4. Delete ΓòÉΓòÉΓòÉ
  836.  
  837.  Function Syntax 
  838.  Parameters 
  839.  Return Values 
  840.  Notes 
  841.  Usage 
  842.  Related methods 
  843.  
  844.  
  845. ΓòÉΓòÉΓòÉ <hidden> Delete - Function Syntax ΓòÉΓòÉΓòÉ
  846.  
  847. /*******************************************************
  848. /* The Delete method is used to delete a fax job
  849. /*******************************************************
  850.  
  851. APIRET rc ;
  852. FaxJob * self ;
  853.  
  854. rc = FaxJob_Delete ( self ) ;
  855.  
  856.  
  857. ΓòÉΓòÉΓòÉ <hidden> Delete - Parameters ΓòÉΓòÉΓòÉ
  858.  
  859.  self (FaxJob *) - input 
  860.      Fax job object 
  861.  
  862.  
  863. ΓòÉΓòÉΓòÉ <hidden> Delete - Return Values ΓòÉΓòÉΓòÉ
  864.  
  865. The possible return values are the following : 
  866.  
  867.  FAX_JOB_OK 
  868.  FAX_JOBERR_NOSETUP 
  869.  FAX_JOBERR_MEMORYALLOCFAILED 
  870.  FAX_JOBERR_REQUESTNOTFOUND 
  871.  FAX_JOBERR_JOBINPROGRESS 
  872.  FAX_JOBERR_BADUSERNAME 
  873.  
  874.  
  875. ΓòÉΓòÉΓòÉ <hidden> Delete - Notes ΓòÉΓòÉΓòÉ
  876.  
  877. The number of the job to delete must be set before calling this method. It can 
  878. be done with Get... or SetJobNumber... methods. 
  879.  
  880.  
  881. ΓòÉΓòÉΓòÉ <hidden> Delete - Usage ΓòÉΓòÉΓòÉ
  882.  
  883. Use this method to delete an existing job. 
  884.  
  885.  
  886. ΓòÉΓòÉΓòÉ <hidden> Delete - Related methods ΓòÉΓòÉΓòÉ
  887.  
  888.   Get 
  889.   Update 
  890.   SetJobNumber 
  891.  
  892.  
  893. ΓòÉΓòÉΓòÉ 3.5. GetJobNumber ΓòÉΓòÉΓòÉ
  894.  
  895.  Function Syntax 
  896.  Parameters 
  897.  Return Values 
  898.  Usage 
  899.  Related methods 
  900.  
  901.  
  902. ΓòÉΓòÉΓòÉ <hidden> GetJobNumber - Function Syntax ΓòÉΓòÉΓòÉ
  903.  
  904. /*******************************************************
  905. /* The GetJobNumber method retrieves job number from object data
  906. /*******************************************************
  907.  
  908. APIRET rc ;
  909. FaxJob * self ;
  910. PULONG pulJobNumber;
  911.  
  912. rc = FaxJob_GetJobNumber ( self, pulJobNumber) ;
  913.  
  914.  
  915. ΓòÉΓòÉΓòÉ <hidden> GetJobNumber - Parameters ΓòÉΓòÉΓòÉ
  916.  
  917.  self (FaxJob *) - input 
  918.      Fax job object 
  919.  
  920.  pulNewReqNumber (PULONG) - output 
  921.      number of the job . 
  922.  
  923.  
  924. ΓòÉΓòÉΓòÉ <hidden> GetJobNumber - Return Values ΓòÉΓòÉΓòÉ
  925.  
  926. The possible return values are the following : 
  927.  
  928.  FAX_JOB_OK 
  929.  FAX_JOBERR_NOSETUP 
  930.  FAX_JOBERR_MEMORYALLOCFAILED 
  931.  FAX_JOBERR_CREATEFAILED 
  932.  
  933.  
  934. ΓòÉΓòÉΓòÉ <hidden> GetJobNumber - Usage ΓòÉΓòÉΓòÉ
  935.  
  936. Use this method to get a number of the current job. 
  937.  
  938.  
  939. ΓòÉΓòÉΓòÉ <hidden> GetJobNumber - Related methods ΓòÉΓòÉΓòÉ
  940.  
  941.   Get 
  942.   SetJobNumber 
  943.  
  944.  
  945. ΓòÉΓòÉΓòÉ 3.6. GetFaxNumber ΓòÉΓòÉΓòÉ
  946.  
  947.  Function Syntax 
  948.  Parameters 
  949.  Return Values 
  950.  Usage 
  951.  Related methods 
  952.  
  953.  
  954. ΓòÉΓòÉΓòÉ <hidden> GetFaxNumber - Function Syntax ΓòÉΓòÉΓòÉ
  955.  
  956. /************************************
  957. /* The GetFaxNumber method retrieves
  958. /* the fax number from object data
  959. /************************************
  960.  
  961. APIRET rc ;
  962. FaxJob * self ;
  963. PSZ pszFaxNumber;
  964. PULONG pulLen;
  965.  
  966. rc = FaxJob_GetFaxNumber ( self, pszFaxNumber, pulLen) ;
  967.  
  968.  
  969. ΓòÉΓòÉΓòÉ <hidden> GetFaxNumber - Parameters ΓòÉΓòÉΓòÉ
  970.  
  971.  self (FaxJob *) - input 
  972.      Fax job object 
  973.  
  974.  pszFaxNumber (PSZ) 
  975.      If not NULL, receives the fax number . 
  976.  
  977.  pulLen (PULONG) - output 
  978.      If pszFaxNumber is NULL pulLen receives the length of the buffer required 
  979.      for the fax number . 
  980.  
  981.  
  982. ΓòÉΓòÉΓòÉ <hidden> GetFaxNumber - Return Values ΓòÉΓòÉΓòÉ
  983.  
  984. The possible return values are the following : 
  985.  
  986.  FAX_JOB_OK 
  987.  FAX_JOBERR_NOSETUP 
  988.  
  989.  
  990. ΓòÉΓòÉΓòÉ <hidden> GetFaxNumber - Usage ΓòÉΓòÉΓòÉ
  991.  
  992. Use this method to get a recipient fax number for the current job. 
  993.  
  994.  
  995. ΓòÉΓòÉΓòÉ <hidden> GetFaxNumber - Related methods ΓòÉΓòÉΓòÉ
  996.  
  997.   Get 
  998.   SetFaxNumber 
  999.  
  1000.  
  1001. ΓòÉΓòÉΓòÉ 3.7. GetAttention ΓòÉΓòÉΓòÉ
  1002.  
  1003.  Function Syntax 
  1004.  Parameters 
  1005.  Return Values 
  1006.  Usage 
  1007.  Related methods 
  1008.  
  1009.  
  1010. ΓòÉΓòÉΓòÉ <hidden> GetAttention - Function Syntax ΓòÉΓòÉΓòÉ
  1011.  
  1012. /************************************
  1013. /* The GetAttention method retrieves
  1014. /* the recipient name from object data
  1015. /************************************
  1016.  
  1017. APIRET rc ;
  1018. FaxJob * self ;
  1019. PSZ pszAttention;
  1020. PULONG pulLen;
  1021.  
  1022. rc = FaxJob_GetAttention ( self, pszAttention, pulLen) ;
  1023.  
  1024.  
  1025. ΓòÉΓòÉΓòÉ <hidden> GetAttention - Parameters ΓòÉΓòÉΓòÉ
  1026.  
  1027.  self (FaxJob *) - input 
  1028.      Fax job object 
  1029.  
  1030.  pszAttention (PSZ) 
  1031.      If not NULL, receives the recipient name. 
  1032.  
  1033.  pulLen (PULONG) - output 
  1034.      If pszAttention is NULL pulLen receives the length of the buffer required 
  1035.      for the recipient name . 
  1036.  
  1037.  
  1038. ΓòÉΓòÉΓòÉ <hidden> GetAttention - Return Values ΓòÉΓòÉΓòÉ
  1039.  
  1040. The possible return values are the following : 
  1041.  
  1042.  FAX_JOB_OK 
  1043.  FAX_JOBERR_NOSETUP 
  1044.  
  1045.  
  1046. ΓòÉΓòÉΓòÉ <hidden> GetAttention - Usage ΓòÉΓòÉΓòÉ
  1047.  
  1048. Use this method to get a recipient name for the current job 
  1049.  
  1050.  
  1051. ΓòÉΓòÉΓòÉ <hidden> GetAttention - Related methods ΓòÉΓòÉΓòÉ
  1052.  
  1053.   Get 
  1054.   SetAttention 
  1055.  
  1056.  
  1057. ΓòÉΓòÉΓòÉ 3.8. GetExternalCall ΓòÉΓòÉΓòÉ
  1058.  
  1059.  Function Syntax 
  1060.  Parameters 
  1061.  Return Values 
  1062.  Usage 
  1063.  Related methods 
  1064.  
  1065.  
  1066. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Function Syntax ΓòÉΓòÉΓòÉ
  1067.  
  1068. /************************************
  1069. /* The GetExternalCall method retrieves
  1070. /* the external call flag from object data
  1071. /************************************
  1072.  
  1073. APIRET rc ;
  1074. FaxJob * self ;
  1075. PULONG pulExtCall;
  1076.  
  1077. rc = FaxJob_GetExternalCall ( self, pulExtCall) ;
  1078.  
  1079.  
  1080. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Parameters ΓòÉΓòÉΓòÉ
  1081.  
  1082.  self (FaxJob *) - input 
  1083.      Fax job object 
  1084.  
  1085.  pulExtCall (PULONG) - output 
  1086.      external call flag. 
  1087.  
  1088.  
  1089. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Return Values ΓòÉΓòÉΓòÉ
  1090.  
  1091. The possible return values are the following : 
  1092.  
  1093.  FAX_JOB_OK 
  1094.  FAX_JOBERR_NOSETUP 
  1095.  
  1096.  
  1097. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Usage ΓòÉΓòÉΓòÉ
  1098.  
  1099. Use this method to get the external call flag of the current job 
  1100.  
  1101.  
  1102. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Related methods ΓòÉΓòÉΓòÉ
  1103.  
  1104.   Get 
  1105.   SetExternalCall 
  1106.  
  1107.  
  1108. ΓòÉΓòÉΓòÉ 3.9. GetDocName ΓòÉΓòÉΓòÉ
  1109.  
  1110.  Function Syntax 
  1111.  Parameters 
  1112.  Return Values 
  1113.  Usage 
  1114.  Related methods 
  1115.  
  1116.  
  1117. ΓòÉΓòÉΓòÉ <hidden> GetDocName - Function Syntax ΓòÉΓòÉΓòÉ
  1118.  
  1119. /************************************
  1120. /* The GetDocName method retrieves
  1121. /* the fax file name from object data
  1122. /************************************
  1123.  
  1124. APIRET rc ;
  1125. FaxJob * self ;
  1126. PSZ pszDocName;
  1127. PULONG pulLen;
  1128.  
  1129. rc = FaxJob_GetDocName ( self, pszDocName, pulLen) ;
  1130.  
  1131.  
  1132. ΓòÉΓòÉΓòÉ <hidden> GetDocName - Parameters ΓòÉΓòÉΓòÉ
  1133.  
  1134.  self (FaxJob *) - input 
  1135.      Fax job object 
  1136.  
  1137.  pszDocName (PSZ) 
  1138.      If not NULL, receives the fax file name. 
  1139.  
  1140.  pulLen (PULONG) - output 
  1141.      If pszDocName is NULL pulLen receives the length of the buffer required 
  1142.      for the fax file name. 
  1143.  
  1144.  
  1145. ΓòÉΓòÉΓòÉ <hidden> GetDocName - Return Values ΓòÉΓòÉΓòÉ
  1146.  
  1147. The possible return values are the following : 
  1148.  
  1149.  FAX_JOB_OK 
  1150.  FAX_JOBERR_NOSETUP 
  1151.  
  1152.  
  1153. ΓòÉΓòÉΓòÉ <hidden> GetDocName - Usage ΓòÉΓòÉΓòÉ
  1154.  
  1155. Use this method to get the name of the fax file for the current job 
  1156.  
  1157.  
  1158. ΓòÉΓòÉΓòÉ <hidden> GetDocName - Related methods ΓòÉΓòÉΓòÉ
  1159.  
  1160.   Get 
  1161.   SetDocName 
  1162.  
  1163.  
  1164. ΓòÉΓòÉΓòÉ 3.10. GetFaxMgrId ΓòÉΓòÉΓòÉ
  1165.  
  1166.  Function Syntax 
  1167.  Parameters 
  1168.  Return Values 
  1169.  Usage 
  1170.  Related methods 
  1171.  
  1172.  
  1173. ΓòÉΓòÉΓòÉ <hidden> GetFaxMgrId - Function Syntax ΓòÉΓòÉΓòÉ
  1174.  
  1175. /************************************
  1176. /* The GetFaxMgrId method retrieves
  1177. /* the sender workstation ID from object data
  1178. /************************************
  1179.  
  1180. APIRET rc ;
  1181. FaxJob * self ;
  1182. PSZ pszDocName;
  1183. PULONG pulLen;
  1184.  
  1185. rc = FaxJob_GetFaxMgrId ( self, pszFaxMgrId, pulLen) ;
  1186.  
  1187.  
  1188. ΓòÉΓòÉΓòÉ <hidden> GetFaxMgrId - Parameters ΓòÉΓòÉΓòÉ
  1189.  
  1190.  self (FaxJob *) - input 
  1191.      Fax job object 
  1192.  
  1193.  pszFaxMgrId (PSZ) 
  1194.      If not NULL, receives the sender workstation ID. 
  1195.  
  1196.  pulLen (PULONG) - output 
  1197.      If pszFaxMgrId is NULL pulLen receives the length of the buffer required 
  1198.      for the sender ID. 
  1199.  
  1200.  
  1201. ΓòÉΓòÉΓòÉ <hidden> GetFaxMgrId - Return Values ΓòÉΓòÉΓòÉ
  1202.  
  1203. The possible return values are the following : 
  1204.  
  1205.  FAX_JOB_OK 
  1206.  FAX_JOBERR_NOSETUP 
  1207.  
  1208.  
  1209. ΓòÉΓòÉΓòÉ <hidden> GetFaxMgrId - Usage ΓòÉΓòÉΓòÉ
  1210.  
  1211. Use this method to get the sender workstation ID for the current job 
  1212.  
  1213.  
  1214. ΓòÉΓòÉΓòÉ <hidden> GetFaxMgrId - Related methods ΓòÉΓòÉΓòÉ
  1215.  
  1216.   Get 
  1217.   SetFaxMgrId 
  1218.  
  1219.  
  1220. ΓòÉΓòÉΓòÉ 3.11. GetUserName ΓòÉΓòÉΓòÉ
  1221.  
  1222.  Function Syntax 
  1223.  Parameters 
  1224.  Return Values 
  1225.  Usage 
  1226.  Related methods 
  1227.  
  1228.  
  1229. ΓòÉΓòÉΓòÉ <hidden> GetUserName - Function Syntax ΓòÉΓòÉΓòÉ
  1230.  
  1231. /************************************
  1232. /* The GetUserName method retrieves
  1233. /* the user name from object data
  1234. /************************************
  1235.  
  1236. APIRET rc ;
  1237. FaxJob * self ;
  1238. PSZ pszDocName;
  1239. PULONG pulLen;
  1240.  
  1241. rc = FaxJob_GetUserName ( self, pszUserName, pulLen) ;
  1242.  
  1243.  
  1244. ΓòÉΓòÉΓòÉ <hidden> GetUserName - Parameters ΓòÉΓòÉΓòÉ
  1245.  
  1246.  self (FaxJob *) - input 
  1247.      Fax job object 
  1248.  
  1249.  pszUserName (PSZ) 
  1250.      If not NULL, receives the user name. 
  1251.  
  1252.  pulLen (PULONG) - output 
  1253.      If pszUserName is NULL pulLen receives the length of the buffer required 
  1254.      for the user name. 
  1255.  
  1256.  
  1257. ΓòÉΓòÉΓòÉ <hidden> GetUserName - Return Values ΓòÉΓòÉΓòÉ
  1258.  
  1259. The possible return values are the following : 
  1260.  
  1261.  FAX_JOB_OK 
  1262.  FAX_JOBERR_NOSETUP 
  1263.  
  1264.  
  1265. ΓòÉΓòÉΓòÉ <hidden> GetUserName - Usage ΓòÉΓòÉΓòÉ
  1266.  
  1267. Use this method to get the user name. 
  1268.  
  1269.  
  1270. ΓòÉΓòÉΓòÉ <hidden> GetUserName - Related methods ΓòÉΓòÉΓòÉ
  1271.  
  1272.   Get 
  1273.   SetUserName 
  1274.  
  1275.  
  1276. ΓòÉΓòÉΓòÉ 3.12. GetDocType ΓòÉΓòÉΓòÉ
  1277.  
  1278.  Function Syntax 
  1279.  Parameters 
  1280.  Return Values 
  1281.  Usage 
  1282.  Related methods 
  1283.  
  1284.  
  1285. ΓòÉΓòÉΓòÉ <hidden> GetDocType - Function Syntax ΓòÉΓòÉΓòÉ
  1286.  
  1287. /************************************
  1288. /* The GetDocType method retrieves the format
  1289. /* of the fax file from object data
  1290. /************************************
  1291.  
  1292. APIRET rc ;
  1293. FaxJob * self ;
  1294. PSZ pszDocType;
  1295. PULONG pulLen;
  1296.  
  1297. rc = FaxJob_GetDocType ( self, pszDocType, pulLen) ;
  1298.  
  1299.  
  1300. ΓòÉΓòÉΓòÉ <hidden> GetDocType - Parameters ΓòÉΓòÉΓòÉ
  1301.  
  1302.  self (FaxJob *) - input 
  1303.      Fax job object 
  1304.  
  1305.  pszDocType (PSZ) 
  1306.      If not NULL, receives the format of the fax file. 
  1307.  
  1308.  pulLen (PULONG) - output 
  1309.      If pszDocType is NULL pulLen receives the length of the buffer required 
  1310.      for the fax file format . 
  1311.  
  1312.  
  1313. ΓòÉΓòÉΓòÉ <hidden> GetDocType - Return Values ΓòÉΓòÉΓòÉ
  1314.  
  1315. The possible return values are the following : 
  1316.  
  1317.  FAX_JOB_OK 
  1318.  FAX_JOBERR_NOSETUP 
  1319.  
  1320.  
  1321. ΓòÉΓòÉΓòÉ <hidden> GetDocType - Usage ΓòÉΓòÉΓòÉ
  1322.  
  1323. Use this method to get the format of the fax file. 
  1324.  
  1325.  
  1326. ΓòÉΓòÉΓòÉ <hidden> GetDocType - Related methods ΓòÉΓòÉΓòÉ
  1327.  
  1328.   Get 
  1329.   SetDocType 
  1330.  
  1331.  
  1332. ΓòÉΓòÉΓòÉ 3.13. GetStartTime ΓòÉΓòÉΓòÉ
  1333.  
  1334.  Function Syntax 
  1335.  Parameters 
  1336.  Return Values 
  1337.  Usage 
  1338.  Related methods 
  1339.  
  1340.  
  1341. ΓòÉΓòÉΓòÉ <hidden> GetStartTime - Function Syntax ΓòÉΓòÉΓòÉ
  1342.  
  1343. /************************************
  1344. /* The GetStartTime method retrieves
  1345. /* the start time  from object data
  1346. /************************************
  1347.  
  1348. APIRET rc ;
  1349. FaxJob * self ;
  1350. PULONG pulTime;
  1351.  
  1352. rc = FaxJob_GetStartTime ( self, pulTime) ;
  1353.  
  1354.  
  1355. ΓòÉΓòÉΓòÉ <hidden> GetStartTime - Parameters ΓòÉΓòÉΓòÉ
  1356.  
  1357.  self (FaxJob *) - input 
  1358.      Fax job object 
  1359.  
  1360.  pulTime (PULONG) - output 
  1361.      Start time . 
  1362.  
  1363.  
  1364. ΓòÉΓòÉΓòÉ <hidden> GetStartTime - Return Values ΓòÉΓòÉΓòÉ
  1365.  
  1366. The possible return values are the following : 
  1367.  
  1368.  FAX_JOB_OK 
  1369.  FAX_JOBERR_NOSETUP 
  1370.  
  1371.  
  1372. ΓòÉΓòÉΓòÉ <hidden> GetStartTime - Usage ΓòÉΓòÉΓòÉ
  1373.  
  1374. Use this method to get the start time for the current job. 
  1375.  
  1376.  
  1377. ΓòÉΓòÉΓòÉ <hidden> GetStartTime - Related methods ΓòÉΓòÉΓòÉ
  1378.  
  1379.   Get 
  1380.   SetStartTime 
  1381.  
  1382.  
  1383. ΓòÉΓòÉΓòÉ 3.14. GetEndTime ΓòÉΓòÉΓòÉ
  1384.  
  1385.  Function Syntax 
  1386.  Parameters 
  1387.  Return Values 
  1388.  Usage 
  1389.  Related methods 
  1390.  
  1391.  
  1392. ΓòÉΓòÉΓòÉ <hidden> GetEndTime - Function Syntax ΓòÉΓòÉΓòÉ
  1393.  
  1394. /************************************
  1395. /* The GetEndTime method retrieves
  1396. /* the time limit from object data
  1397. /************************************
  1398.  
  1399. APIRET rc ;
  1400. FaxJob * self ;
  1401. PULONG pulTime;
  1402.  
  1403. rc = FaxJob_GetEndTime ( self, pulTime) ;
  1404.  
  1405.  
  1406. ΓòÉΓòÉΓòÉ <hidden> GetEndTime - Parameters ΓòÉΓòÉΓòÉ
  1407.  
  1408.  self (FaxJob *) - input 
  1409.      Fax job object 
  1410.  
  1411.  pulTime (PULONG) - output 
  1412.      Time limit. 
  1413.  
  1414.  
  1415. ΓòÉΓòÉΓòÉ <hidden> GetEndTime - Return Values ΓòÉΓòÉΓòÉ
  1416.  
  1417. The possible return values are the following : 
  1418.  
  1419.  FAX_JOB_OK 
  1420.  FAX_JOBERR_NOSETUP 
  1421.  
  1422.  
  1423. ΓòÉΓòÉΓòÉ <hidden> GetEndTime - Usage ΓòÉΓòÉΓòÉ
  1424.  
  1425. Use this method to get the time limit for the current job. 
  1426.  
  1427.  
  1428. ΓòÉΓòÉΓòÉ <hidden> GetEndTime - Related methods ΓòÉΓòÉΓòÉ
  1429.  
  1430.   Get 
  1431.   SetEndTime 
  1432.  
  1433.  
  1434. ΓòÉΓòÉΓòÉ 3.15. GetRetriesDone ΓòÉΓòÉΓòÉ
  1435.  
  1436.  Function Syntax 
  1437.  Parameters 
  1438.  Return Values 
  1439.  Usage 
  1440.  Related methods 
  1441.  
  1442.  
  1443. ΓòÉΓòÉΓòÉ <hidden> GetRetriesDone - Function Syntax ΓòÉΓòÉΓòÉ
  1444.  
  1445. /************************************
  1446. /* The GetRetriesDone method retrieves
  1447. /* the the number of attempts already
  1448. /* done.
  1449. /************************************
  1450.  
  1451. APIRET rc ;
  1452. FaxJob * self ;
  1453. PULONG pulRetries;
  1454.  
  1455. rc = FaxJob_GetRetriesDone ( self, pulRetries) ;
  1456.  
  1457.  
  1458. ΓòÉΓòÉΓòÉ <hidden> GetRetriesDone - Parameters ΓòÉΓòÉΓòÉ
  1459.  
  1460.  self (FaxJob *) - input 
  1461.      Fax job object 
  1462.  
  1463.  pulRetries (PULONG) - output 
  1464.      Number of attempts already done. 
  1465.  
  1466.  
  1467. ΓòÉΓòÉΓòÉ <hidden> GetRetriesDone - Return Values ΓòÉΓòÉΓòÉ
  1468.  
  1469. The possible return values are the following : 
  1470.  
  1471.  FAX_JOB_OK 
  1472.  FAX_JOBERR_NOSETUP 
  1473.  
  1474.  
  1475. ΓòÉΓòÉΓòÉ <hidden> GetRetriesDone - Usage ΓòÉΓòÉΓòÉ
  1476.  
  1477. Use this method to get the number of attempts already done for the current job. 
  1478.  
  1479.  
  1480. ΓòÉΓòÉΓòÉ <hidden> GetRetriesDone - Related methods ΓòÉΓòÉΓòÉ
  1481.  
  1482.   Get 
  1483.   SetRetriesDone 
  1484.  
  1485.  
  1486. ΓòÉΓòÉΓòÉ 3.16. GetMaxRetries ΓòÉΓòÉΓòÉ
  1487.  
  1488.  Function Syntax 
  1489.  Parameters 
  1490.  Return Values 
  1491.  Usage 
  1492.  Related methods 
  1493.  
  1494.  
  1495. ΓòÉΓòÉΓòÉ <hidden> GetMaxRetries - Function Syntax ΓòÉΓòÉΓòÉ
  1496.  
  1497. /************************************
  1498. /* The GetMaxRetries method retrieves
  1499. /* the the maximum number of attempts.
  1500. /************************************
  1501.  
  1502. APIRET rc ;
  1503. FaxJob * self ;
  1504. PULONG pulRetries;
  1505.  
  1506. rc = FaxJob_GetMaxRetries ( self, pulRetries) ;
  1507.  
  1508.  
  1509. ΓòÉΓòÉΓòÉ <hidden> GetMaxRetries - Parameters ΓòÉΓòÉΓòÉ
  1510.  
  1511.  self (FaxJob *) - input 
  1512.      Fax job object 
  1513.  
  1514.  pulRetries (PULONG) - output 
  1515.      Maximum number of attempts . 
  1516.  
  1517.  
  1518. ΓòÉΓòÉΓòÉ <hidden> GetMaxRetries - Return Values ΓòÉΓòÉΓòÉ
  1519.  
  1520. The possible return values are the following : 
  1521.  
  1522.  FAX_JOB_OK 
  1523.  FAX_JOBERR_NOSETUP 
  1524.  
  1525.  
  1526. ΓòÉΓòÉΓòÉ <hidden> GetMaxRetries - Usage ΓòÉΓòÉΓòÉ
  1527.  
  1528. Use this method to get the number maximum of attempts for the current job. 
  1529.  
  1530.  
  1531. ΓòÉΓòÉΓòÉ <hidden> GetMaxRetries - Related methods ΓòÉΓòÉΓòÉ
  1532.  
  1533.   Get 
  1534.   SetMaxRetries 
  1535.  
  1536.  
  1537. ΓòÉΓòÉΓòÉ 3.17. GetStatus ΓòÉΓòÉΓòÉ
  1538.  
  1539.  Function Syntax 
  1540.  Parameters 
  1541.  Return Values 
  1542.  Usage 
  1543.  Related methods 
  1544.  
  1545.  
  1546. ΓòÉΓòÉΓòÉ <hidden> GetStatus - Function Syntax ΓòÉΓòÉΓòÉ
  1547.  
  1548. /************************************
  1549. /* The GetStatus method retrieves
  1550. /* the status of the job
  1551. /************************************
  1552.  
  1553. APIRET rc ;
  1554. FaxJob * self ;
  1555. PULONG pulStatus;
  1556.  
  1557. rc = FaxJob_GetStatus ( self, pulStatus) ;
  1558.  
  1559.  
  1560. ΓòÉΓòÉΓòÉ <hidden> GetStatus - Parameters ΓòÉΓòÉΓòÉ
  1561.  
  1562.  self (FaxJob *) - input 
  1563.      Fax job object 
  1564.  
  1565.  pulStatus (PULONG) - output 
  1566.      Status of the job. 
  1567.  
  1568.      The possible values are the following : FAX_JOB_READY FAX_JOB_HELD 
  1569.      FAX_JOB_IN_PROGRESS FAX_JOB_CANCELLED FAX_JOB_LIMIT FAX_JOB_DONE 
  1570.  
  1571.  
  1572. ΓòÉΓòÉΓòÉ <hidden> GetStatus - Return Values ΓòÉΓòÉΓòÉ
  1573.  
  1574. The possible return values are the following : 
  1575.  
  1576.  FAX_JOB_OK 
  1577.  FAX_JOBERR_NOSETUP 
  1578.  
  1579.  
  1580. ΓòÉΓòÉΓòÉ <hidden> GetStatus - Usage ΓòÉΓòÉΓòÉ
  1581.  
  1582. Use this method to get the status of the current job. 
  1583.  
  1584.  
  1585. ΓòÉΓòÉΓòÉ <hidden> GetStatus - Related methods ΓòÉΓòÉΓòÉ
  1586.  
  1587.   Get 
  1588.   SetStatus 
  1589.  
  1590.  
  1591. ΓòÉΓòÉΓòÉ 3.18. GetCriteria ΓòÉΓòÉΓòÉ
  1592.  
  1593.  Function Syntax 
  1594.  Parameters 
  1595.  Return Values 
  1596.  Usage 
  1597.  Related methods 
  1598.  
  1599.  
  1600. ΓòÉΓòÉΓòÉ <hidden> GetCriteria - Function Syntax ΓòÉΓòÉΓòÉ
  1601.  
  1602. /************************************
  1603. /* The GetCriteria method retrieves
  1604. /* send criteria (by time or by retry).
  1605. /************************************
  1606.  
  1607. APIRET rc ;
  1608. FaxJob * self ;
  1609. PULONG pulCrit;
  1610.  
  1611. rc = FaxJob_GetCriteria ( self, pulCrit) ;
  1612.  
  1613.  
  1614. ΓòÉΓòÉΓòÉ <hidden> GetCriteria - Parameters ΓòÉΓòÉΓòÉ
  1615.  
  1616.  self (FaxJob *) - input 
  1617.      Fax job object 
  1618.  
  1619.  pulCrit (PULONG) - output 
  1620.      send criteria. 
  1621.  
  1622.      The possible values are the following : FAX_JOB_BYTIME FAX_JOB_BYRETRY 
  1623.  
  1624.  
  1625. ΓòÉΓòÉΓòÉ <hidden> GetCriteria - Return Values ΓòÉΓòÉΓòÉ
  1626.  
  1627. The possible return values are the following : 
  1628.  
  1629.  FAX_JOB_OK 
  1630.  FAX_JOBERR_NOSETUP 
  1631.  
  1632.  
  1633. ΓòÉΓòÉΓòÉ <hidden> GetCriteria - Usage ΓòÉΓòÉΓòÉ
  1634.  
  1635. Use this method to get the job send criteria (by time or by retry). 
  1636.  
  1637.  
  1638. ΓòÉΓòÉΓòÉ <hidden> GetCriteria - Related methods ΓòÉΓòÉΓòÉ
  1639.  
  1640.   Get 
  1641.   SetCriteria 
  1642.  
  1643.  
  1644. ΓòÉΓòÉΓòÉ 3.19. GetErrorMessage ΓòÉΓòÉΓòÉ
  1645.  
  1646.  Function Syntax 
  1647.  Parameters 
  1648.  Return Values 
  1649.  Usage 
  1650.  Related methods 
  1651.  
  1652.  
  1653. ΓòÉΓòÉΓòÉ <hidden> GetErrorMessage - Function Syntax ΓòÉΓòÉΓòÉ
  1654.  
  1655. /************************************
  1656. /* The GetErrorMessage method retrieves
  1657. /* the error message from object data
  1658. /************************************
  1659.  
  1660. APIRET rc ;
  1661. FaxJob * self ;
  1662. PSZ pszErr;
  1663. PULONG pulLen;
  1664.  
  1665. rc = FaxJob_GetErrorMessage ( self, pszErr, pulLen) ;
  1666.  
  1667.  
  1668. ΓòÉΓòÉΓòÉ <hidden> GetErrorMessage - Parameters ΓòÉΓòÉΓòÉ
  1669.  
  1670.  self (FaxJob *) - input 
  1671.      Fax job object 
  1672.  
  1673.  pszErr (PSZ) 
  1674.      If not NULL, receives the error message . 
  1675.  
  1676.  pulLen (PULONG) - output 
  1677.      If pszErr is NULL pulLen receives the length of the buffer required for 
  1678.      the error message. 
  1679.  
  1680.  
  1681. ΓòÉΓòÉΓòÉ <hidden> GetErrorMessage - Return Values ΓòÉΓòÉΓòÉ
  1682.  
  1683. The possible return values are the following : 
  1684.  
  1685.  FAX_JOB_OK 
  1686.  FAX_JOBERR_NOSETUP 
  1687.  
  1688.  
  1689. ΓòÉΓòÉΓòÉ <hidden> GetErrorMessage - Usage ΓòÉΓòÉΓòÉ
  1690.  
  1691. Use this method to get the error message . 
  1692.  
  1693.  
  1694. ΓòÉΓòÉΓòÉ <hidden> GetErrorMessage - Related methods ΓòÉΓòÉΓòÉ
  1695.  
  1696.   Get 
  1697.  
  1698.  
  1699. ΓòÉΓòÉΓòÉ 3.20. GetDocTypes ΓòÉΓòÉΓòÉ
  1700.  
  1701.  Function Syntax 
  1702.  Parameters 
  1703.  Return Values 
  1704.  Notes 
  1705.  Usage 
  1706.  Related methods 
  1707.  
  1708.  
  1709. ΓòÉΓòÉΓòÉ <hidden> GetDocTypes - Function Syntax ΓòÉΓòÉΓòÉ
  1710.  
  1711. /************************************
  1712. /* The GetDocTypes method retrieves
  1713. /* the list of the fax file formats.
  1714. /************************************
  1715.  
  1716. APIRET rc ;
  1717. FaxJob * self ;
  1718. PSZ pszDocTypes;
  1719. PULONG pulLen;
  1720.  
  1721. rc = FaxJob_GetDocTypes ( self, pszDocTypes, pulLen) ;
  1722.  
  1723.  
  1724. ΓòÉΓòÉΓòÉ <hidden> GetDocTypes - Parameters ΓòÉΓòÉΓòÉ
  1725.  
  1726.  self (FaxJob *) - input 
  1727.      Fax job object 
  1728.  
  1729.  pszDocTypes (PSZ) 
  1730.      If not NULL, receives the list of the fax file formats. The list is 
  1731.      terminated by a double NULL character. All the formats in the list are 
  1732.      separated by NULL characters. 
  1733.  
  1734.  pulLen (PULONG) - output 
  1735.      If pszDocTypes is NULL pulLen receives the length of the buffer required 
  1736.      for the list. 
  1737.  
  1738.  
  1739. ΓòÉΓòÉΓòÉ <hidden> GetDocTypes - Return Values ΓòÉΓòÉΓòÉ
  1740.  
  1741. The possible return values are the following : 
  1742.  
  1743.  FAX_JOB_OK 
  1744.  FAX_JOBERR_NOSETUP 
  1745.  
  1746.  
  1747. ΓòÉΓòÉΓòÉ <hidden> GetDocTypes - Notes ΓòÉΓòÉΓòÉ
  1748.  
  1749. This method is used to get list of the fax file formats. 
  1750.  
  1751.  
  1752. ΓòÉΓòÉΓòÉ <hidden> GetDocTypes - Usage ΓòÉΓòÉΓòÉ
  1753.  
  1754. Use this method to get the list of the fax file formats. 
  1755.  
  1756.  
  1757. ΓòÉΓòÉΓòÉ <hidden> GetDocTypes - Related methods ΓòÉΓòÉΓòÉ
  1758.  
  1759.   Get 
  1760.   GetDocType 
  1761.   SetDocType 
  1762.  
  1763.  
  1764. ΓòÉΓòÉΓòÉ 3.21. SetJobNumber ΓòÉΓòÉΓòÉ
  1765.  
  1766.  Function Syntax 
  1767.  Parameters 
  1768.  Return Values 
  1769.  Usage 
  1770.  Related methods 
  1771.  
  1772.  
  1773. ΓòÉΓòÉΓòÉ <hidden> SetJobNumber - Function Syntax ΓòÉΓòÉΓòÉ
  1774.  
  1775. /************************************
  1776. /* The SetJobNumber method retrieves
  1777. /* send criteria (by time or by retry).
  1778. /************************************
  1779.  
  1780. APIRET  rc ;
  1781. FaxJob  * self ;
  1782. ULONG   ulJobNumber;
  1783.  
  1784. rc = FaxJob_SetJobNumber ( self, ulJobNumber) ;
  1785.  
  1786.  
  1787. ΓòÉΓòÉΓòÉ <hidden> SetJobNumber - Parameters ΓòÉΓòÉΓòÉ
  1788.  
  1789.  self (FaxJob *) - input 
  1790.      Fax job object 
  1791.  
  1792.  ulJobNumber (PULONG) - output 
  1793.      Job number. 
  1794.  
  1795.  
  1796. ΓòÉΓòÉΓòÉ <hidden> SetJobNumber - Return Values ΓòÉΓòÉΓòÉ
  1797.  
  1798. The possible return values are the following : 
  1799.  
  1800.  FAX_JOB_OK 
  1801.  FAX_JOBERR_NOSETUP 
  1802.  
  1803.  
  1804. ΓòÉΓòÉΓòÉ <hidden> SetJobNumber - Usage ΓòÉΓòÉΓòÉ
  1805.  
  1806. Use this method to set the current job number . 
  1807.  
  1808.  
  1809. ΓòÉΓòÉΓòÉ <hidden> SetJobNumber - Related methods ΓòÉΓòÉΓòÉ
  1810.  
  1811.   GetJobNumber 
  1812.  
  1813.  
  1814. ΓòÉΓòÉΓòÉ 3.22. SetFaxNumber ΓòÉΓòÉΓòÉ
  1815.  
  1816.  Function Syntax 
  1817.  Parameters 
  1818.  Return Values 
  1819.  Usage 
  1820.  Related methods 
  1821.  
  1822.  
  1823. ΓòÉΓòÉΓòÉ <hidden> SetFaxNumber - Function Syntax ΓòÉΓòÉΓòÉ
  1824.  
  1825. /************************************
  1826. /* The SetFaxNumber method sets
  1827. /* the fax number in the object data.
  1828. /************************************
  1829.  
  1830. APIRET rc ;
  1831. FaxJob * self ;
  1832. PSZ pszFaxNumber;
  1833.  
  1834. rc = FaxJob_SetFaxNumber ( self, pszFaxNumber) ;
  1835.  
  1836.  
  1837. ΓòÉΓòÉΓòÉ <hidden> SetFaxNumber - Parameters ΓòÉΓòÉΓòÉ
  1838.  
  1839.  self (FaxJob *) - input 
  1840.      Fax job object 
  1841.  
  1842.  pszFaxNumber (PSZ) 
  1843.      Pointer to the fax number string. 
  1844.  
  1845.  
  1846. ΓòÉΓòÉΓòÉ <hidden> SetFaxNumber - Return Values ΓòÉΓòÉΓòÉ
  1847.  
  1848. The possible return values are the following : 
  1849.  
  1850.  FAX_JOB_OK 
  1851.  FAX_JOBERR_NOSETUP 
  1852.  FAX_JOBERR_STRINGTOOLONG 
  1853.  
  1854.  
  1855. ΓòÉΓòÉΓòÉ <hidden> SetFaxNumber - Usage ΓòÉΓòÉΓòÉ
  1856.  
  1857. Use this method to set the fax number of the current job. 
  1858.  
  1859.  
  1860. ΓòÉΓòÉΓòÉ <hidden> SetFaxNumber - Related methods ΓòÉΓòÉΓòÉ
  1861.  
  1862.   GetJobNumber 
  1863.  
  1864.  
  1865. ΓòÉΓòÉΓòÉ 3.23. SetAttention ΓòÉΓòÉΓòÉ
  1866.  
  1867.  Function Syntax 
  1868.  Parameters 
  1869.  Return Values 
  1870.  Usage 
  1871.  Related methods 
  1872.  
  1873.  
  1874. ΓòÉΓòÉΓòÉ <hidden> SetAttention - Function Syntax ΓòÉΓòÉΓòÉ
  1875.  
  1876. /************************************
  1877. /* The SetAttention method sets
  1878. /* the recipient name in the object data.
  1879. /************************************
  1880.  
  1881. APIRET rc ;
  1882. FaxJob * self ;
  1883. PSZ pszAttention;
  1884.  
  1885. rc = FaxJob_SetAttention ( self, pszAttention) ;
  1886.  
  1887.  
  1888. ΓòÉΓòÉΓòÉ <hidden> SetAttention - Parameters ΓòÉΓòÉΓòÉ
  1889.  
  1890.  self (FaxJob *) - input 
  1891.      Fax job object 
  1892.  
  1893.  pszAttention (PSZ) 
  1894.      Pointer to the recipient name. 
  1895.  
  1896.  
  1897. ΓòÉΓòÉΓòÉ <hidden> SetAttention - Return Values ΓòÉΓòÉΓòÉ
  1898.  
  1899. The possible return values are the following : 
  1900.  
  1901.  FAX_JOB_OK 
  1902.  FAX_JOBERR_NOSETUP 
  1903.  FAX_JOBERR_STRINGTOOLONG 
  1904.  
  1905.  
  1906. ΓòÉΓòÉΓòÉ <hidden> SetAttention - Usage ΓòÉΓòÉΓòÉ
  1907.  
  1908. Use this method to set the recipient name for the current job. 
  1909.  
  1910.  
  1911. ΓòÉΓòÉΓòÉ <hidden> SetAttention - Related methods ΓòÉΓòÉΓòÉ
  1912.  
  1913.   GetAttention 
  1914.  
  1915.  
  1916. ΓòÉΓòÉΓòÉ 3.24. SetExternalCall ΓòÉΓòÉΓòÉ
  1917.  
  1918.  Function Syntax 
  1919.  Parameters 
  1920.  Return Values 
  1921.  Usage 
  1922.  Related methods 
  1923.  
  1924.  
  1925. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Function Syntax ΓòÉΓòÉΓòÉ
  1926.  
  1927. /************************************
  1928. /* The SetExternalCall method sets
  1929. /* the external call flag in the object data.
  1930. /************************************
  1931.  
  1932. APIRET  rc ;
  1933. FaxJob  * self ;
  1934. ULONG   ulExternalCall;
  1935.  
  1936. rc = FaxJob_SetExternalCall ( self, ulExternalCall) ;
  1937.  
  1938.  
  1939. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Parameters ΓòÉΓòÉΓòÉ
  1940.  
  1941.  self (FaxJob *) - input 
  1942.      Fax job object 
  1943.  
  1944.  ulExternalCall (PULONG) - output 
  1945.      External call flag. 
  1946.  
  1947.  
  1948. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Return Values ΓòÉΓòÉΓòÉ
  1949.  
  1950. The possible return values are the following : 
  1951.  
  1952.  FAX_JOB_OK 
  1953.  FAX_JOBERR_NOSETUP 
  1954.  
  1955.  
  1956. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Usage ΓòÉΓòÉΓòÉ
  1957.  
  1958. Use this method to set the external call flag for the current job. 
  1959.  
  1960.  
  1961. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Related methods ΓòÉΓòÉΓòÉ
  1962.  
  1963.   GetExternalCall 
  1964.  
  1965.  
  1966. ΓòÉΓòÉΓòÉ 3.25. SetDocName ΓòÉΓòÉΓòÉ
  1967.  
  1968.  Function Syntax 
  1969.  Parameters 
  1970.  Return Values 
  1971.  Usage 
  1972.  Related methods 
  1973.  
  1974.  
  1975. ΓòÉΓòÉΓòÉ <hidden> SetDocName - Function Syntax ΓòÉΓòÉΓòÉ
  1976.  
  1977. /************************************
  1978. /* The SetDocName method sets the document
  1979. /* name ( file to send ) in the object data.
  1980. /************************************
  1981.  
  1982. APIRET rc ;
  1983. FaxJob * self ;
  1984. PSZ pszDocName;
  1985.  
  1986. rc = FaxJob_SetDocName ( self, pszDocName) ;
  1987.  
  1988.  
  1989. ΓòÉΓòÉΓòÉ <hidden> SetDocName - Parameters ΓòÉΓòÉΓòÉ
  1990.  
  1991.  self (FaxJob *) - input 
  1992.      Fax job object 
  1993.  
  1994.  pszDocName (PSZ) 
  1995.      Pointer to the document name. 
  1996.  
  1997.  
  1998. ΓòÉΓòÉΓòÉ <hidden> SetDocName - Return Values ΓòÉΓòÉΓòÉ
  1999.  
  2000. The possible return values are the following : 
  2001.  
  2002.  FAX_JOB_OK 
  2003.  FAX_JOBERR_NOSETUP 
  2004.  FAX_JOBERR_STRINGTOOLONG 
  2005.  
  2006.  
  2007. ΓòÉΓòÉΓòÉ <hidden> SetDocName - Usage ΓòÉΓòÉΓòÉ
  2008.  
  2009. Use this method to set the fax file name for the current job. 
  2010.  
  2011.  
  2012. ΓòÉΓòÉΓòÉ <hidden> SetDocName - Related methods ΓòÉΓòÉΓòÉ
  2013.  
  2014.   GetDocName 
  2015.  
  2016.  
  2017. ΓòÉΓòÉΓòÉ 3.26. SetFaxMgrId ΓòÉΓòÉΓòÉ
  2018.  
  2019.  Function Syntax 
  2020.  Parameters 
  2021.  Return Values 
  2022.  Usage 
  2023.  Related methods 
  2024.  
  2025.  
  2026. ΓòÉΓòÉΓòÉ <hidden> SetFaxMgrId - Function Syntax ΓòÉΓòÉΓòÉ
  2027.  
  2028. /************************************
  2029. /* The SetFaxMgrId method sets the
  2030. /* sender workstation ID in the object data.
  2031. /************************************
  2032.  
  2033. APIRET rc ;
  2034. FaxJob * self ;
  2035. PSZ pszFaxMgrId;
  2036.  
  2037. rc = FaxJob_SetFaxMgrId ( self, pszFaxMgrId) ;
  2038.  
  2039.  
  2040. ΓòÉΓòÉΓòÉ <hidden> SetFaxMgrId - Parameters ΓòÉΓòÉΓòÉ
  2041.  
  2042.  self (FaxJob *) - input 
  2043.      Fax job object. 
  2044.  
  2045.  pszFaxMgrId (PSZ) 
  2046.      Pointer to the sender workstation ID. 
  2047.  
  2048.  
  2049. ΓòÉΓòÉΓòÉ <hidden> SetFaxMgrId - Return Values ΓòÉΓòÉΓòÉ
  2050.  
  2051. The possible return values are the following : 
  2052.  
  2053.  FAX_JOB_OK 
  2054.  FAX_JOBERR_NOSETUP 
  2055.  FAX_JOBERR_STRINGTOOLONG 
  2056.  
  2057.  
  2058. ΓòÉΓòÉΓòÉ <hidden> SetFaxMgrId - Usage ΓòÉΓòÉΓòÉ
  2059.  
  2060. Use this method to set the sender workstation ID for the current job. 
  2061.  
  2062.  
  2063. ΓòÉΓòÉΓòÉ <hidden> SetFaxMgrId - Related methods ΓòÉΓòÉΓòÉ
  2064.  
  2065.   GetFaxMgrId 
  2066.  
  2067.  
  2068. ΓòÉΓòÉΓòÉ 3.27. SetUserName ΓòÉΓòÉΓòÉ
  2069.  
  2070.  Function Syntax 
  2071.  Parameters 
  2072.  Return Values 
  2073.  Usage 
  2074.  Related methods 
  2075.  
  2076.  
  2077. ΓòÉΓòÉΓòÉ <hidden> SetUserName - Function Syntax ΓòÉΓòÉΓòÉ
  2078.  
  2079. /************************************
  2080. /* The SetUserName method sets
  2081. /* the user name in the object data.
  2082. /************************************
  2083.  
  2084. APIRET rc ;
  2085. FaxJob * self ;
  2086. PSZ pszUserName;
  2087.  
  2088. rc = FaxJob_SetUserName ( self, pszUserName) ;
  2089.  
  2090.  
  2091. ΓòÉΓòÉΓòÉ <hidden> SetUserName - Parameters ΓòÉΓòÉΓòÉ
  2092.  
  2093.  self (FaxJob *) - input 
  2094.      Fax job object 
  2095.  
  2096.  pszUserName (PSZ) 
  2097.      Pointer to the user name . 
  2098.  
  2099.  
  2100. ΓòÉΓòÉΓòÉ <hidden> SetUserName - Return Values ΓòÉΓòÉΓòÉ
  2101.  
  2102. The possible return values are the following : 
  2103.  
  2104.  FAX_JOB_OK 
  2105.  FAX_JOBERR_NOSETUP 
  2106.  FAX_JOBERR_STRINGTOOLONG 
  2107.  
  2108.  
  2109. ΓòÉΓòÉΓòÉ <hidden> SetUserName - Usage ΓòÉΓòÉΓòÉ
  2110.  
  2111. Use this method to set the user name. 
  2112.  
  2113.  
  2114. ΓòÉΓòÉΓòÉ <hidden> SetUserName - Related methods ΓòÉΓòÉΓòÉ
  2115.  
  2116.   GetUserName 
  2117.  
  2118.  
  2119. ΓòÉΓòÉΓòÉ 3.28. SetDocType ΓòÉΓòÉΓòÉ
  2120.  
  2121.  Function Syntax 
  2122.  Parameters 
  2123.  Return Values 
  2124.  Usage 
  2125.  Related methods 
  2126.  
  2127.  
  2128. ΓòÉΓòÉΓòÉ <hidden> SetDocType - Function Syntax ΓòÉΓòÉΓòÉ
  2129.  
  2130. /************************************
  2131. /* The SetDocType method sets the fax
  2132. /* file format in the object data.
  2133. /************************************
  2134.  
  2135. APIRET rc ;
  2136. FaxJob * self ;
  2137. PSZ pszDocType;
  2138.  
  2139. rc = FaxJob_SetDocType ( self, pszDocType) ;
  2140.  
  2141.  
  2142. ΓòÉΓòÉΓòÉ <hidden> SetDocType - Parameters ΓòÉΓòÉΓòÉ
  2143.  
  2144.  self (FaxJob *) - input 
  2145.      Fax job object 
  2146.  
  2147.  pszDocType (PSZ) 
  2148.      Pointer to the fax file format. 
  2149.  
  2150.  
  2151. ΓòÉΓòÉΓòÉ <hidden> SetDocType - Return Values ΓòÉΓòÉΓòÉ
  2152.  
  2153. The possible return values are the following : 
  2154.  
  2155.  FAX_JOB_OK 
  2156.  FAX_JOBERR_NOSETUP 
  2157.  FAX_JOBERR_STRINGTOOLONG 
  2158.  
  2159.  
  2160. ΓòÉΓòÉΓòÉ <hidden> SetDocType - Usage ΓòÉΓòÉΓòÉ
  2161.  
  2162. Use this method to set the fax file format for the current job. 
  2163.  
  2164.  
  2165. ΓòÉΓòÉΓòÉ <hidden> SetDocType - Related methods ΓòÉΓòÉΓòÉ
  2166.  
  2167.   GetDocType 
  2168.  
  2169.  
  2170. ΓòÉΓòÉΓòÉ 3.29. SetStartTime ΓòÉΓòÉΓòÉ
  2171.  
  2172.  Function Syntax 
  2173.  Parameters 
  2174.  Return Values 
  2175.  Usage 
  2176.  Related methods 
  2177.  
  2178.  
  2179. ΓòÉΓòÉΓòÉ <hidden> SetStartTime - Function Syntax ΓòÉΓòÉΓòÉ
  2180.  
  2181. /************************************
  2182. /* The SetStartTime method sets
  2183. /* the start time in the object data.
  2184. /************************************
  2185.  
  2186. APIRET  rc ;
  2187. FaxJob  * self ;
  2188. ULONG   ulStartTime;
  2189.  
  2190. rc = FaxJob_SetStartTime ( self, ulStartTime) ;
  2191.  
  2192.  
  2193. ΓòÉΓòÉΓòÉ <hidden> SetStartTime - Parameters ΓòÉΓòÉΓòÉ
  2194.  
  2195.  self (FaxJob *) - input 
  2196.      Fax job object 
  2197.  
  2198.  ulStartTime (PULONG) - output 
  2199.      Start time . 
  2200.  
  2201.  
  2202. ΓòÉΓòÉΓòÉ <hidden> SetStartTime - Return Values ΓòÉΓòÉΓòÉ
  2203.  
  2204. The possible return values are the following : 
  2205.  
  2206.  FAX_JOB_OK 
  2207.  FAX_JOBERR_NOSETUP 
  2208.  
  2209.  
  2210. ΓòÉΓòÉΓòÉ <hidden> SetStartTime - Usage ΓòÉΓòÉΓòÉ
  2211.  
  2212. Use this method to set the start time for the current job. 
  2213.  
  2214.  
  2215. ΓòÉΓòÉΓòÉ <hidden> SetStartTime - Related methods ΓòÉΓòÉΓòÉ
  2216.  
  2217.   GetStartTime 
  2218.  
  2219.  
  2220. ΓòÉΓòÉΓòÉ 3.30. SetEndTime ΓòÉΓòÉΓòÉ
  2221.  
  2222.  Function Syntax 
  2223.  Parameters 
  2224.  Return Values 
  2225.  Usage 
  2226.  Related methods 
  2227.  
  2228.  
  2229. ΓòÉΓòÉΓòÉ <hidden> SetEndTime - Function Syntax ΓòÉΓòÉΓòÉ
  2230.  
  2231. /************************************
  2232. /* The SetEndTime method sets
  2233. /* the time limit in the object data.
  2234. /************************************
  2235.  
  2236. APIRET  rc ;
  2237. FaxJob  * self ;
  2238. ULONG   ulEndTime;
  2239.  
  2240. rc = FaxJob_SetEndTime ( self, ulEndTime) ;
  2241.  
  2242.  
  2243. ΓòÉΓòÉΓòÉ <hidden> SetEndTime - Parameters ΓòÉΓòÉΓòÉ
  2244.  
  2245.  self (FaxJob *) - input 
  2246.      Fax job object 
  2247.  
  2248.  ulEndTime (PULONG) - output 
  2249.      Time limit . 
  2250.  
  2251.  
  2252. ΓòÉΓòÉΓòÉ <hidden> SetEndTime - Return Values ΓòÉΓòÉΓòÉ
  2253.  
  2254. The possible return values are the following : 
  2255.  
  2256.  FAX_JOB_OK 
  2257.  FAX_JOBERR_NOSETUP 
  2258.  
  2259.  
  2260. ΓòÉΓòÉΓòÉ <hidden> SetEndTime - Usage ΓòÉΓòÉΓòÉ
  2261.  
  2262. Use this method to set the time limit for the current job. 
  2263.  
  2264.  
  2265. ΓòÉΓòÉΓòÉ <hidden> SetEndTime - Related methods ΓòÉΓòÉΓòÉ
  2266.  
  2267.   GetEndTime 
  2268.  
  2269.  
  2270. ΓòÉΓòÉΓòÉ 3.31. SetRetriesDone ΓòÉΓòÉΓòÉ
  2271.  
  2272.  Function Syntax 
  2273.  Parameters 
  2274.  Return Values 
  2275.  Usage 
  2276.  Related methods 
  2277.  
  2278.  
  2279. ΓòÉΓòÉΓòÉ <hidden> SetRetriesDone - Function Syntax ΓòÉΓòÉΓòÉ
  2280.  
  2281. /************************************
  2282. /* The SetRetriesDone method sets
  2283. /* the number of attempts alreeady done.
  2284. /************************************
  2285.  
  2286. APIRET  rc ;
  2287. FaxJob  * self ;
  2288. ULONG   ulRetriesDone;
  2289.  
  2290. rc = FaxJob_SetRetriesDone ( self, ulRetriesDone) ;
  2291.  
  2292.  
  2293. ΓòÉΓòÉΓòÉ <hidden> SetRetriesDone - Parameters ΓòÉΓòÉΓòÉ
  2294.  
  2295.  self (FaxJob *) - input 
  2296.      Fax job object 
  2297.  
  2298.  ulRetriesDone (PULONG) - output 
  2299.      Number of attempts alreeady done. 
  2300.  
  2301.  
  2302. ΓòÉΓòÉΓòÉ <hidden> SetRetriesDone - Return Values ΓòÉΓòÉΓòÉ
  2303.  
  2304. The possible return values are the following : 
  2305.  
  2306.  FAX_JOB_OK 
  2307.  FAX_JOBERR_NOSETUP 
  2308.  
  2309.  
  2310. ΓòÉΓòÉΓòÉ <hidden> SetRetriesDone - Usage ΓòÉΓòÉΓòÉ
  2311.  
  2312. Use this method to set the number of attempts alreeady done for the current 
  2313. job. 
  2314.  
  2315.  
  2316. ΓòÉΓòÉΓòÉ <hidden> SetRetriesDone - Related methods ΓòÉΓòÉΓòÉ
  2317.  
  2318.   GetRetriesDone 
  2319.  
  2320.  
  2321. ΓòÉΓòÉΓòÉ 3.32. SetMaxRetries ΓòÉΓòÉΓòÉ
  2322.  
  2323.  Function Syntax 
  2324.  Parameters 
  2325.  Return Values 
  2326.  Usage 
  2327.  Related methods 
  2328.  
  2329.  
  2330. ΓòÉΓòÉΓòÉ <hidden> SetMaxRetries - Function Syntax ΓòÉΓòÉΓòÉ
  2331.  
  2332. /************************************
  2333. /* The SetMaxRetries method sets
  2334. /* the maximum number of attempts .
  2335. /************************************
  2336.  
  2337. APIRET  rc ;
  2338. FaxJob  * self ;
  2339. ULONG   ulMaxRetries;
  2340.  
  2341. rc = FaxJob_SetMaxRetries ( self, ulMaxRetries) ;
  2342.  
  2343.  
  2344. ΓòÉΓòÉΓòÉ <hidden> SetMaxRetries - Parameters ΓòÉΓòÉΓòÉ
  2345.  
  2346.  self (FaxJob *) - input 
  2347.      Fax job object 
  2348.  
  2349.  ulMaxRetries (PULONG) - output 
  2350.      Maximum number of attempts . 
  2351.  
  2352.  
  2353. ΓòÉΓòÉΓòÉ <hidden> SetMaxRetries - Return Values ΓòÉΓòÉΓòÉ
  2354.  
  2355. The possible return values are the following : 
  2356.  
  2357.  FAX_JOB_OK 
  2358.  FAX_JOBERR_NOSETUP 
  2359.  
  2360.  
  2361. ΓòÉΓòÉΓòÉ <hidden> SetMaxRetries - Usage ΓòÉΓòÉΓòÉ
  2362.  
  2363. Use this method to set the maximum number of attempts for the current job. 
  2364.  
  2365.  
  2366. ΓòÉΓòÉΓòÉ <hidden> SetMaxRetries - Related methods ΓòÉΓòÉΓòÉ
  2367.  
  2368.   GetMaxRetries 
  2369.  
  2370.  
  2371. ΓòÉΓòÉΓòÉ 3.33. SetStatus ΓòÉΓòÉΓòÉ
  2372.  
  2373.  Function Syntax 
  2374.  Parameters 
  2375.  Return Values 
  2376.  Usage 
  2377.  Related methods 
  2378.  
  2379.  
  2380. ΓòÉΓòÉΓòÉ <hidden> SetStatus - Function Syntax ΓòÉΓòÉΓòÉ
  2381.  
  2382. /************************************
  2383. /* The SetStatus method sets
  2384. /* the status of the job.
  2385. /************************************
  2386.  
  2387. APIRET  rc ;
  2388. FaxJob  * self ;
  2389. ULONG   ulStatus;
  2390.  
  2391. rc = FaxJob_SetStatus ( self, ulStatus) ;
  2392.  
  2393.  
  2394. ΓòÉΓòÉΓòÉ <hidden> SetStatus - Parameters ΓòÉΓòÉΓòÉ
  2395.  
  2396.  self (FaxJob *) - input 
  2397.      Fax job object 
  2398.  
  2399.  ulStatus (PULONG) - output 
  2400.      Status of the job. 
  2401.  
  2402.      The possible values are the following : FAX_JOB_READY FAX_JOB_HELD 
  2403.  
  2404.  
  2405. ΓòÉΓòÉΓòÉ <hidden> SetStatus - Return Values ΓòÉΓòÉΓòÉ
  2406.  
  2407. The possible return values are the following : 
  2408.  
  2409.  FAX_JOB_OK 
  2410.  FAX_JOBERR_NOSETUP 
  2411.  FAX_JOBERR_BADSTATE 
  2412.  
  2413.  
  2414. ΓòÉΓòÉΓòÉ <hidden> SetStatus - Usage ΓòÉΓòÉΓòÉ
  2415.  
  2416. Use this method to set the status of the current job. 
  2417.  
  2418.  
  2419. ΓòÉΓòÉΓòÉ <hidden> SetStatus - Related methods ΓòÉΓòÉΓòÉ
  2420.  
  2421.   GetStatus 
  2422.  
  2423.  
  2424. ΓòÉΓòÉΓòÉ 3.34. SetCriteria ΓòÉΓòÉΓòÉ
  2425.  
  2426.  Function Syntax 
  2427.  Parameters 
  2428.  Return Values 
  2429.  Usage 
  2430.  Related methods 
  2431.  
  2432.  
  2433. ΓòÉΓòÉΓòÉ <hidden> SetCriteria - Function Syntax ΓòÉΓòÉΓòÉ
  2434.  
  2435. /************************************
  2436. /* The SetCriteria method sets
  2437. /* the send criteria (by time or by retry).
  2438. /************************************
  2439.  
  2440. APIRET  rc ;
  2441. FaxJob  * self ;
  2442. ULONG   ulCriteria;
  2443.  
  2444. rc = FaxJob_SetCriteria ( self, ulCriteria) ;
  2445.  
  2446.  
  2447. ΓòÉΓòÉΓòÉ <hidden> SetCriteria - Parameters ΓòÉΓòÉΓòÉ
  2448.  
  2449.  self (FaxJob *) - input 
  2450.      Fax job object 
  2451.  
  2452.  ulCriteria (PULONG) - output 
  2453.      Send criteria. 
  2454.  
  2455.      The possible values are the following : FAX_JOB_BYTIME FAX_JOB_BYRETRY 
  2456.  
  2457.  
  2458. ΓòÉΓòÉΓòÉ <hidden> SetCriteria - Return Values ΓòÉΓòÉΓòÉ
  2459.  
  2460. The possible return values are the following : 
  2461.  
  2462.  FAX_JOB_OK 
  2463.  FAX_JOBERR_NOSETUP 
  2464.  
  2465.  
  2466. ΓòÉΓòÉΓòÉ <hidden> SetCriteria - Usage ΓòÉΓòÉΓòÉ
  2467.  
  2468. Use this method to set the send criteria for the current job. 
  2469.  
  2470.  
  2471. ΓòÉΓòÉΓòÉ <hidden> SetCriteria - Related methods ΓòÉΓòÉΓòÉ
  2472.  
  2473.   SetCriteria 
  2474.  
  2475.  
  2476. ΓòÉΓòÉΓòÉ 3.35. Setup ΓòÉΓòÉΓòÉ
  2477.  
  2478.  Function Syntax 
  2479.  Parameters 
  2480.  Return Values 
  2481.  Notes 
  2482.  Usage 
  2483.  
  2484.  
  2485. ΓòÉΓòÉΓòÉ <hidden> Setup - Function Syntax ΓòÉΓòÉΓòÉ
  2486.  
  2487. /************************************
  2488. /* The Setup method initialises
  2489. /* the object according to the user name .
  2490. /************************************
  2491.  
  2492. APIRET rc ;
  2493. FaxJob * self ;
  2494. PSZ pszUserName;
  2495.  
  2496. rc = FaxJob_Setup ( self, pszUserName) ;
  2497.  
  2498.  
  2499. ΓòÉΓòÉΓòÉ <hidden> Setup - Parameters ΓòÉΓòÉΓòÉ
  2500.  
  2501.  self (FaxJob *) - input 
  2502.      Fax job object 
  2503.  
  2504.  pszUserName (PSZ) 
  2505.      Pointer to the user name . 
  2506.  
  2507.  
  2508. ΓòÉΓòÉΓòÉ <hidden> Setup - Return Values ΓòÉΓòÉΓòÉ
  2509.  
  2510. The possible return values are the following : 
  2511.  
  2512.  FAX_JOB_OK 
  2513.  FAX_JOBERR_STRINGTOOLONG 
  2514.  
  2515.  
  2516. ΓòÉΓòÉΓòÉ <hidden> Setup - Notes ΓòÉΓòÉΓòÉ
  2517.  
  2518. Mandatory init to manipulate fax object. It is to be issued after _somNew. If a 
  2519. call to any method is made before calling the Setup the call will return 
  2520. FAX_JOBERR_NOSETUP. 
  2521.  
  2522. The parameter pszUserName is the name of the owner of the job. No control is 
  2523. made in this version of the API. 
  2524.  
  2525.  
  2526. ΓòÉΓòÉΓòÉ <hidden> Setup - Usage ΓòÉΓòÉΓòÉ
  2527.  
  2528. Call this method to perform the setup of the job before calling any other 
  2529. method. 
  2530.  
  2531.  
  2532. ΓòÉΓòÉΓòÉ 3.36. FaxJobReset ΓòÉΓòÉΓòÉ
  2533.  
  2534.  Function Syntax 
  2535.  Parameters 
  2536.  Return Values 
  2537.  Usage 
  2538.  Related methods 
  2539.  
  2540.  
  2541. ΓòÉΓòÉΓòÉ <hidden> FaxJobReset - Function Syntax ΓòÉΓòÉΓòÉ
  2542.  
  2543. /*****************************************
  2544. /* The FaxJobReset method is
  2545. /* used to reset a fax job object
  2546. /*****************************************
  2547.  
  2548. APIRET rc ;
  2549. FaxJob * self ;
  2550.  
  2551. rc = FaxJob_FaxJobReset ( self ) ;
  2552.  
  2553.  
  2554. ΓòÉΓòÉΓòÉ <hidden> FaxJobReset - Parameters ΓòÉΓòÉΓòÉ
  2555.  
  2556.  self (FaxJob *) - input 
  2557.      Fax job object 
  2558.  
  2559.  
  2560. ΓòÉΓòÉΓòÉ <hidden> FaxJobReset - Return Values ΓòÉΓòÉΓòÉ
  2561.  
  2562. The possible return values are the following : 
  2563.  
  2564.  FAX_JOB_OK 
  2565.  FAX_JOBERR_NOSETUP 
  2566.  
  2567.  
  2568. ΓòÉΓòÉΓòÉ <hidden> FaxJobReset - Usage ΓòÉΓòÉΓòÉ
  2569.  
  2570. Use this method to reset a fax job object. 
  2571.  
  2572.  
  2573. ΓòÉΓòÉΓòÉ <hidden> FaxJobReset - Related methods ΓòÉΓòÉΓòÉ
  2574.  
  2575.   SetCriteria 
  2576.  
  2577.  
  2578. ΓòÉΓòÉΓòÉ 4. FaxJobHeader Class ΓòÉΓòÉΓòÉ
  2579.  
  2580. The FaxJobHeader class allows you to manage the Fax/PM headers. This class is 
  2581. used with the FaxJob class. 
  2582.  
  2583. With the FaxJob class, you can create a request, and with the FaxJobHeader 
  2584. class you can create a header for the fax to send. 
  2585.  
  2586.  
  2587. ΓòÉΓòÉΓòÉ 4.1. GetHeader ΓòÉΓòÉΓòÉ
  2588.  
  2589.  Function Syntax 
  2590.  Parameters 
  2591.  Return Values 
  2592.  Notes 
  2593.  Usage 
  2594.  Related methods 
  2595.  
  2596.  
  2597. ΓòÉΓòÉΓòÉ <hidden> GetHeader - Function Syntax ΓòÉΓòÉΓòÉ
  2598.  
  2599. /***********************************
  2600. /* The GetHeader method is used
  2601. /* to load a header
  2602. /***********************************
  2603.  
  2604. APIRET rc ;
  2605. FaxJobHeader * self ;
  2606. ULONG ulJobNumber;
  2607.  
  2608. rc = FaxJobHeader_GetHeader ( self, ulJobNumber) ;
  2609.  
  2610.  
  2611. ΓòÉΓòÉΓòÉ <hidden> GetHeader - Parameters ΓòÉΓòÉΓòÉ
  2612.  
  2613.  self (FaxJobHeader *) - input 
  2614.      Fax job header object 
  2615.  
  2616.  ulJobNumber (PSZ) - input 
  2617.      number of the job which header is to load. 
  2618.  
  2619.  
  2620. ΓòÉΓòÉΓòÉ <hidden> GetHeader - Return Values ΓòÉΓòÉΓòÉ
  2621.  
  2622. The possible return values are the following : 
  2623.  
  2624.  FAX_HEADER_OK 
  2625.  FAX_HERR_NOSETUP 
  2626.  FAX_HERR_HEADERNOTFOUND 
  2627.  
  2628.  
  2629. ΓòÉΓòÉΓòÉ <hidden> GetHeader - Notes ΓòÉΓòÉΓòÉ
  2630.  
  2631. This method is used to load an existing header. All the informations about the 
  2632. header are stored in the header object. 
  2633.  
  2634.  
  2635. ΓòÉΓòÉΓòÉ <hidden> GetHeader - Usage ΓòÉΓòÉΓòÉ
  2636.  
  2637. Use this method to load an existing header. 
  2638.  
  2639.  
  2640. ΓòÉΓòÉΓòÉ <hidden> GetHeader - Related methods ΓòÉΓòÉΓòÉ
  2641.  
  2642.   Update 
  2643.   Delete 
  2644.  
  2645.  
  2646. ΓòÉΓòÉΓòÉ 4.2. Create ΓòÉΓòÉΓòÉ
  2647.  
  2648.  Function Syntax 
  2649.  Parameters 
  2650.  Return Values 
  2651.  Notes 
  2652.  Usage 
  2653.  Related methods 
  2654.  
  2655.  
  2656. ΓòÉΓòÉΓòÉ <hidden> Create - Function Syntax ΓòÉΓòÉΓòÉ
  2657.  
  2658. /***********************************
  2659. /* The Create method is used to create
  2660. /* a header for an existing job
  2661. /***********************************
  2662.  
  2663. APIRET rc ;
  2664. FaxJobHeader * self ;
  2665. ULONG ulJobNumber;
  2666.  
  2667. rc = FaxJobHeader_Create ( self, ulJobNumber) ;
  2668.  
  2669.  
  2670. ΓòÉΓòÉΓòÉ <hidden> Create - Parameters ΓòÉΓòÉΓòÉ
  2671.  
  2672.  self (FaxJobHeader *) - input 
  2673.      Fax job header object 
  2674.  
  2675.  ulJobNumber (PSZ) - input 
  2676.      number of the job for which the header is to create. 
  2677.  
  2678.  
  2679. ΓòÉΓòÉΓòÉ <hidden> Create - Return Values ΓòÉΓòÉΓòÉ
  2680.  
  2681. The possible return values are the following : 
  2682.  
  2683.  FAX_HEADER_OK 
  2684.  FAX_HERR_NOSETUP 
  2685.  FAX_HERR_ALREADYCREATED 
  2686.  FAX_HERR_CANNOTCREATE 
  2687.  
  2688.  
  2689. ΓòÉΓòÉΓòÉ <hidden> Create - Notes ΓòÉΓòÉΓòÉ
  2690.  
  2691. This method is used to create a header for an existing job . 
  2692.  
  2693.  
  2694. ΓòÉΓòÉΓòÉ <hidden> Create - Usage ΓòÉΓòÉΓòÉ
  2695.  
  2696. Use this method to create a header . 
  2697.  
  2698.  
  2699. ΓòÉΓòÉΓòÉ <hidden> Create - Related methods ΓòÉΓòÉΓòÉ
  2700.  
  2701.   GetHeader 
  2702.   Update 
  2703.   Delete 
  2704.  
  2705.  
  2706. ΓòÉΓòÉΓòÉ 4.3. Update ΓòÉΓòÉΓòÉ
  2707.  
  2708.  Function Syntax 
  2709.  Parameters 
  2710.  Return Values 
  2711.  Notes 
  2712.  Usage 
  2713.  Related methods 
  2714.  
  2715.  
  2716. ΓòÉΓòÉΓòÉ <hidden> Update - Function Syntax ΓòÉΓòÉΓòÉ
  2717.  
  2718. /***********************************
  2719. /* The Update method is used to update
  2720. /* an existing header
  2721. /***********************************
  2722.  
  2723. APIRET rc ;
  2724. FaxJobHeader * self ;
  2725. ULONG ulJobNumber;
  2726.  
  2727. rc = FaxJobHeader_Update ( self, ulJobNumber) ;
  2728.  
  2729.  
  2730. ΓòÉΓòÉΓòÉ <hidden> Update - Parameters ΓòÉΓòÉΓòÉ
  2731.  
  2732.  self (FaxJobHeader *) - input 
  2733.      Fax job header object 
  2734.  
  2735.  ulJobNumber (PSZ) - input 
  2736.      number of the job for which the header is to update. 
  2737.  
  2738.  
  2739. ΓòÉΓòÉΓòÉ <hidden> Update - Return Values ΓòÉΓòÉΓòÉ
  2740.  
  2741. The possible return values are the following : 
  2742.  
  2743.  FAX_HEADER_OK 
  2744.  FAX_HERR_NOSETUP 
  2745.  FAX_HERR_HEADERNOTFOUND 
  2746.  FAX_HERR_CANNOTUPDATE 
  2747.  
  2748.  
  2749. ΓòÉΓòÉΓòÉ <hidden> Update - Notes ΓòÉΓòÉΓòÉ
  2750.  
  2751. This method is used to update an existing header. 
  2752.  
  2753.  
  2754. ΓòÉΓòÉΓòÉ <hidden> Update - Usage ΓòÉΓòÉΓòÉ
  2755.  
  2756. Use this method to update a header . 
  2757.  
  2758.  
  2759. ΓòÉΓòÉΓòÉ <hidden> Update - Related methods ΓòÉΓòÉΓòÉ
  2760.  
  2761.   GetHeader 
  2762.   Create 
  2763.   Delete 
  2764.  
  2765.  
  2766. ΓòÉΓòÉΓòÉ 4.4. Delete ΓòÉΓòÉΓòÉ
  2767.  
  2768.  Function Syntax 
  2769.  Parameters 
  2770.  Return Values 
  2771.  Notes 
  2772.  Usage 
  2773.  Related methods 
  2774.  
  2775.  
  2776. ΓòÉΓòÉΓòÉ <hidden> Delete - Function Syntax ΓòÉΓòÉΓòÉ
  2777.  
  2778. /***********************************
  2779. /* The Delete method is used to delete
  2780. /* a header.
  2781. /***********************************
  2782.  
  2783. APIRET rc ;
  2784. FaxJobHeader * self ;
  2785. ULONG ulJobNumber;
  2786.  
  2787. rc = FaxJobHeader_Delete ( self, ulJobNumber) ;
  2788.  
  2789.  
  2790. ΓòÉΓòÉΓòÉ <hidden> Delete - Parameters ΓòÉΓòÉΓòÉ
  2791.  
  2792.  self (FaxJobHeader *) - input 
  2793.      Fax job header object 
  2794.  
  2795.  ulJobNumber (PSZ) - input 
  2796.      number of the job which header is to delete. 
  2797.  
  2798.  
  2799. ΓòÉΓòÉΓòÉ <hidden> Delete - Return Values ΓòÉΓòÉΓòÉ
  2800.  
  2801. The possible return values are the following : 
  2802.  
  2803.  FAX_HEADER_OK 
  2804.  FAX_HERR_NOSETUP 
  2805.  FAX_HERR_HEADERNOTFOUND 
  2806.  FAX_HERR_CANNOTDELETE 
  2807.  
  2808.  
  2809. ΓòÉΓòÉΓòÉ <hidden> Delete - Notes ΓòÉΓòÉΓòÉ
  2810.  
  2811. This method is used to delete a header. 
  2812.  
  2813.  
  2814. ΓòÉΓòÉΓòÉ <hidden> Delete - Usage ΓòÉΓòÉΓòÉ
  2815.  
  2816. Use this method to delete a header . 
  2817.  
  2818.  
  2819. ΓòÉΓòÉΓòÉ <hidden> Delete - Related methods ΓòÉΓòÉΓòÉ
  2820.  
  2821.   GetHeader 
  2822.   Create 
  2823.   Update 
  2824.  
  2825.  
  2826. ΓòÉΓòÉΓòÉ 4.5. GetLogo ΓòÉΓòÉΓòÉ
  2827.  
  2828.  Function Syntax 
  2829.  Parameters 
  2830.  Return Values 
  2831.  Usage 
  2832.  Related methods 
  2833.  
  2834.  
  2835. ΓòÉΓòÉΓòÉ <hidden> GetLogo - Function Syntax ΓòÉΓòÉΓòÉ
  2836.  
  2837. /***********************************
  2838. /* The GetLogo method is used to retrieve
  2839. /* the logo file name for the current header.
  2840. /***********************************
  2841.  
  2842. APIRET rc ;
  2843. FaxJobHeader * self ;
  2844. PSZ pszLogoFileName;
  2845. PULONG pulLen;
  2846.  
  2847. rc = FaxJobHeader_GetLogo ( self, pszLogoFileName, pulLen) ;
  2848.  
  2849.  
  2850. ΓòÉΓòÉΓòÉ <hidden> GetLogo - Parameters ΓòÉΓòÉΓòÉ
  2851.  
  2852.  self (FaxJobHeader *) - input 
  2853.      Fax job header object 
  2854.  
  2855.  pszLogoFileName (PSZ) 
  2856.      If not NULL, receives the logo file name. 
  2857.  
  2858.  pulLen (PULONG) - output 
  2859.      If pszLogoFileName is NULL pulLen receives the length of the buffer 
  2860.      required for the logo file name. 
  2861.  
  2862.  
  2863. ΓòÉΓòÉΓòÉ <hidden> GetLogo - Return Values ΓòÉΓòÉΓòÉ
  2864.  
  2865. The possible return values are the following : 
  2866.  
  2867.  FAX_HEADER_OK 
  2868.  FAX_HERR_NOSETUP 
  2869.  
  2870.  
  2871. ΓòÉΓòÉΓòÉ <hidden> GetLogo - Usage ΓòÉΓòÉΓòÉ
  2872.  
  2873. Use this method to get the logo file name for the current header. 
  2874.  
  2875.  
  2876. ΓòÉΓòÉΓòÉ <hidden> GetLogo - Related methods ΓòÉΓòÉΓòÉ
  2877.  
  2878.   GetHeader 
  2879.   SetLogo 
  2880.  
  2881.  
  2882. ΓòÉΓòÉΓòÉ 4.6. GetSenderName ΓòÉΓòÉΓòÉ
  2883.  
  2884.  Function Syntax 
  2885.  Parameters 
  2886.  Return Values 
  2887.  Usage 
  2888.  Related methods 
  2889.  
  2890.  
  2891. ΓòÉΓòÉΓòÉ <hidden> GetSenderName - Function Syntax ΓòÉΓòÉΓòÉ
  2892.  
  2893. /***********************************
  2894. /* The GetSenderName method is used to to retrieve
  2895. /* the sender name for the current header.
  2896. /***********************************
  2897.  
  2898. APIRET rc ;
  2899. FaxJobHeader * self ;
  2900. PSZ pszSenderName;
  2901. PULONG pulLen;
  2902.  
  2903. rc = FaxJobHeader_GetSenderName ( self, pszSenderName, pulLen) ;
  2904.  
  2905.  
  2906. ΓòÉΓòÉΓòÉ <hidden> GetSenderName - Parameters ΓòÉΓòÉΓòÉ
  2907.  
  2908.  self (FaxJobHeader *) - input 
  2909.      Fax job header object 
  2910.  
  2911.  pszSenderName (PSZ) 
  2912.      If not NULL, receives the sender name. 
  2913.  
  2914.  pulLen (PULONG) - output 
  2915.      length of the string for the sender name. If pszSenderName is NULL pulLen 
  2916.      receives the length of the buffer required for the sender name. 
  2917.  
  2918.  
  2919. ΓòÉΓòÉΓòÉ <hidden> GetSenderName - Return Values ΓòÉΓòÉΓòÉ
  2920.  
  2921. The possible return values are the following : 
  2922.  
  2923.  FAX_HEADER_OK 
  2924.  FAX_HERR_NOSETUP 
  2925.  
  2926.  
  2927. ΓòÉΓòÉΓòÉ <hidden> GetSenderName - Usage ΓòÉΓòÉΓòÉ
  2928.  
  2929. Use this method to get the sender name for the current header. 
  2930.  
  2931.  
  2932. ΓòÉΓòÉΓòÉ <hidden> GetSenderName - Related methods ΓòÉΓòÉΓòÉ
  2933.  
  2934.   GetHeader 
  2935.   SetSenderName 
  2936.  
  2937.  
  2938. ΓòÉΓòÉΓòÉ 4.7. GetSenderFax ΓòÉΓòÉΓòÉ
  2939.  
  2940.  Function Syntax 
  2941.  Parameters 
  2942.  Return Values 
  2943.  Usage 
  2944.  Related methods 
  2945.  
  2946.  
  2947. ΓòÉΓòÉΓòÉ <hidden> GetSenderFax - Function Syntax ΓòÉΓòÉΓòÉ
  2948.  
  2949. /***********************************
  2950. /* The GetSenderFax method is used to to retrieve
  2951. /* the sender fax number for the current header.
  2952. /***********************************
  2953.  
  2954. APIRET rc ;
  2955. FaxJobHeader * self ;
  2956. PSZ pszSenderFax;
  2957. PULONG pulLen;
  2958.  
  2959. rc = FaxJobHeader_GetSenderFax ( self, pszSenderFax, pulLen) ;
  2960.  
  2961.  
  2962. ΓòÉΓòÉΓòÉ <hidden> GetSenderFax - Parameters ΓòÉΓòÉΓòÉ
  2963.  
  2964.  self (FaxJobHeader *) - input 
  2965.      Fax job header object 
  2966.  
  2967.  pszSenderFax (PSZ) 
  2968.      If not NULL, receives the sender fax number. 
  2969.  
  2970.  pulLen (PULONG) - output 
  2971.      If pszSenderFax is NULL pulLen receives the length of the buffer required 
  2972.      for the sender fax number. 
  2973.  
  2974.  
  2975. ΓòÉΓòÉΓòÉ <hidden> GetSenderFax - Return Values ΓòÉΓòÉΓòÉ
  2976.  
  2977. The possible return values are the following : 
  2978.  
  2979.  FAX_HEADER_OK 
  2980.  FAX_HERR_NOSETUP 
  2981.  
  2982.  
  2983. ΓòÉΓòÉΓòÉ <hidden> GetSenderFax - Usage ΓòÉΓòÉΓòÉ
  2984.  
  2985. Use this method to get the sender fax number for the current header. 
  2986.  
  2987.  
  2988. ΓòÉΓòÉΓòÉ <hidden> GetSenderFax - Related methods ΓòÉΓòÉΓòÉ
  2989.  
  2990.   GetHeader 
  2991.   SetSenderFax 
  2992.  
  2993.  
  2994. ΓòÉΓòÉΓòÉ 4.8. GetSenderPhone ΓòÉΓòÉΓòÉ
  2995.  
  2996.  Function Syntax 
  2997.  Parameters 
  2998.  Return Values 
  2999.  Usage 
  3000.  Related methods 
  3001.  
  3002.  
  3003. ΓòÉΓòÉΓòÉ <hidden> GetSenderPhone - Function Syntax ΓòÉΓòÉΓòÉ
  3004.  
  3005. /***********************************
  3006. /* The GetSenderPhone method is used to to retrieve
  3007. /* the sender phone number for the current header.
  3008. /***********************************
  3009.  
  3010. APIRET rc ;
  3011. FaxJobHeader * self ;
  3012. PSZ pszSenderPhone;
  3013. PULONG pulLen;
  3014.  
  3015. rc = FaxJobHeader_GetSenderPhone ( self, pszSenderPhone, pulLen) ;
  3016.  
  3017.  
  3018. ΓòÉΓòÉΓòÉ <hidden> GetSenderPhone - Parameters ΓòÉΓòÉΓòÉ
  3019.  
  3020.  self (FaxJobHeader *) - input 
  3021.      Fax job header object 
  3022.  
  3023.  pszSenderPhone (PSZ) 
  3024.      If not NULL, receives the sender phone number. 
  3025.  
  3026.  pulLen (PULONG) - output 
  3027.      If pszSenderPhone is NULL pulLen receives the length of the buffer 
  3028.      required for the sender phone number. 
  3029.  
  3030.  
  3031. ΓòÉΓòÉΓòÉ <hidden> GetSenderPhone - Return Values ΓòÉΓòÉΓòÉ
  3032.  
  3033. The possible return values are the following : 
  3034.  
  3035.  FAX_HEADER_OK 
  3036.  FAX_HERR_NOSETUP 
  3037.  
  3038.  
  3039. ΓòÉΓòÉΓòÉ <hidden> GetSenderPhone - Usage ΓòÉΓòÉΓòÉ
  3040.  
  3041. Use this method to get the sender phone number for the current header. 
  3042.  
  3043.  
  3044. ΓòÉΓòÉΓòÉ <hidden> GetSenderPhone - Related methods ΓòÉΓòÉΓòÉ
  3045.  
  3046.   GetHeader 
  3047.   SetSenderPhone 
  3048.  
  3049.  
  3050. ΓòÉΓòÉΓòÉ 4.9. GetRecipientName ΓòÉΓòÉΓòÉ
  3051.  
  3052.  Function Syntax 
  3053.  Parameters 
  3054.  Return Values 
  3055.  Usage 
  3056.  Related methods 
  3057.  
  3058.  
  3059. ΓòÉΓòÉΓòÉ <hidden> GetRecipientName - Function Syntax ΓòÉΓòÉΓòÉ
  3060.  
  3061. /***********************************
  3062. /* The GetRecipientName method is used to to retrieve
  3063. /* the recipient name for the current header.
  3064. /***********************************
  3065.  
  3066. APIRET rc ;
  3067. FaxJobHeader * self ;
  3068. PSZ pszRecipientName;
  3069. PULONG pulLen;
  3070.  
  3071. rc = FaxJobHeader_GetRecipientName ( self, pszRecipientName, pulLen) ;
  3072.  
  3073.  
  3074. ΓòÉΓòÉΓòÉ <hidden> GetRecipientName - Parameters ΓòÉΓòÉΓòÉ
  3075.  
  3076.  self (FaxJobHeader *) - input 
  3077.      Fax job header object 
  3078.  
  3079.  pszRecipientName (PSZ) 
  3080.      If not NULL, receives the recipient name. 
  3081.  
  3082.  pulLen (PULONG) - output 
  3083.      If pszRecipientName is NULL pulLen receives the length of the buffer 
  3084.      required for the recipient name . 
  3085.  
  3086.  
  3087. ΓòÉΓòÉΓòÉ <hidden> GetRecipientName - Return Values ΓòÉΓòÉΓòÉ
  3088.  
  3089. The possible return values are the following : 
  3090.  
  3091.  FAX_HEADER_OK 
  3092.  FAX_HERR_NOSETUP 
  3093.  
  3094.  
  3095. ΓòÉΓòÉΓòÉ <hidden> GetRecipientName - Usage ΓòÉΓòÉΓòÉ
  3096.  
  3097. Use this method to get the recipient name for the current header. 
  3098.  
  3099.  
  3100. ΓòÉΓòÉΓòÉ <hidden> GetRecipientName - Related methods ΓòÉΓòÉΓòÉ
  3101.  
  3102.   GetHeader 
  3103.   SetRecipientName 
  3104.  
  3105.  
  3106. ΓòÉΓòÉΓòÉ 4.10. GetComment ΓòÉΓòÉΓòÉ
  3107.  
  3108.  Function Syntax 
  3109.  Parameters 
  3110.  Return Values 
  3111.  Usage 
  3112.  Related methods 
  3113.  
  3114.  
  3115. ΓòÉΓòÉΓòÉ <hidden> GetComment - Function Syntax ΓòÉΓòÉΓòÉ
  3116.  
  3117. /***********************************
  3118. /* The GetComment method is used to to retrieve
  3119. /* the comment for the current header.
  3120. /***********************************
  3121.  
  3122. APIRET rc ;
  3123. FaxJobHeader * self ;
  3124. PSZ pszComment;
  3125. PULONG pulLen;
  3126.  
  3127. rc = FaxJobHeader_GetComment ( self, pszComment, pulLen) ;
  3128.  
  3129.  
  3130. ΓòÉΓòÉΓòÉ <hidden> GetComment - Parameters ΓòÉΓòÉΓòÉ
  3131.  
  3132.  self (FaxJobHeader *) - input 
  3133.      Fax job header object 
  3134.  
  3135.  pszComment (PSZ) 
  3136.      If not NULL, receives the comment. 
  3137.  
  3138.  pulLen (PULONG) - output 
  3139.      If pszComment is NULL pulLen receives the length of the buffer required 
  3140.      for the comment. 
  3141.  
  3142.  
  3143. ΓòÉΓòÉΓòÉ <hidden> GetComment - Return Values ΓòÉΓòÉΓòÉ
  3144.  
  3145. The possible return values are the following : 
  3146.  
  3147.  FAX_HEADER_OK 
  3148.  FAX_HERR_NOSETUP 
  3149.  
  3150.  
  3151. ΓòÉΓòÉΓòÉ <hidden> GetComment - Usage ΓòÉΓòÉΓòÉ
  3152.  
  3153. Use this method to get the comment for the current header. 
  3154.  
  3155.  
  3156. ΓòÉΓòÉΓòÉ <hidden> GetComment - Related methods ΓòÉΓòÉΓòÉ
  3157.  
  3158.   GetHeader 
  3159.   SetComment 
  3160.  
  3161.  
  3162. ΓòÉΓòÉΓòÉ 4.11. SetLogo ΓòÉΓòÉΓòÉ
  3163.  
  3164.  Function Syntax 
  3165.  Parameters 
  3166.  Return Values 
  3167.  Usage 
  3168.  Related methods 
  3169.  
  3170.  
  3171. ΓòÉΓòÉΓòÉ <hidden> SetLogo - Function Syntax ΓòÉΓòÉΓòÉ
  3172.  
  3173. /************************************
  3174. /* The SetLogo method sets
  3175. /* the logo file name in the object data.
  3176. /************************************
  3177.  
  3178. APIRET rc ;
  3179. FaxJobHeader * self ;
  3180. PSZ pszLogoFileName;
  3181.  
  3182. rc = FaxJobHeader_SetLogo ( self, pszLogoFileName) ;
  3183.  
  3184.  
  3185. ΓòÉΓòÉΓòÉ <hidden> SetLogo - Parameters ΓòÉΓòÉΓòÉ
  3186.  
  3187.  self (FaxJobHeader *) - input 
  3188.      Fax job header object 
  3189.  
  3190.  pszLogoFileName (PSZ) 
  3191.      Pointer to the logo file name. 
  3192.  
  3193.  
  3194. ΓòÉΓòÉΓòÉ <hidden> SetLogo - Return Values ΓòÉΓòÉΓòÉ
  3195.  
  3196. The possible return values are the following : 
  3197.  
  3198.  FAX_HEADER_OK 
  3199.  FAX_HERR_NOSETUP 
  3200.  FAX_HERR_STRINGTOOLONG 
  3201.  FAX_HERR_BADFILENAME 
  3202.  
  3203.  
  3204. ΓòÉΓòÉΓòÉ <hidden> SetLogo - Usage ΓòÉΓòÉΓòÉ
  3205.  
  3206. Use this method to set the logo file name for the current header. 
  3207.  
  3208.  
  3209. ΓòÉΓòÉΓòÉ <hidden> SetLogo - Related methods ΓòÉΓòÉΓòÉ
  3210.  
  3211.   GetLogo 
  3212.  
  3213.  
  3214. ΓòÉΓòÉΓòÉ 4.12. SetSenderName ΓòÉΓòÉΓòÉ
  3215.  
  3216.  Function Syntax 
  3217.  Parameters 
  3218.  Return Values 
  3219.  Usage 
  3220.  Related methods 
  3221.  
  3222.  
  3223. ΓòÉΓòÉΓòÉ <hidden> SetSenderName - Function Syntax ΓòÉΓòÉΓòÉ
  3224.  
  3225. /************************************
  3226. /* The SetSenderName method sets
  3227. /* the sender name in the object data.
  3228. /************************************
  3229.  
  3230. APIRET rc ;
  3231. FaxJobHeader * self ;
  3232. PSZ pszSenderName;
  3233.  
  3234. rc = FaxJobHeader_SetSenderName ( self, pszSenderName) ;
  3235.  
  3236.  
  3237. ΓòÉΓòÉΓòÉ <hidden> SetSenderName - Parameters ΓòÉΓòÉΓòÉ
  3238.  
  3239.  self (FaxJobHeader *) - input 
  3240.      Fax job header object 
  3241.  
  3242.  pszSenderName (PSZ) 
  3243.      Pointer to the sender name. 
  3244.  
  3245.  
  3246. ΓòÉΓòÉΓòÉ <hidden> SetSenderName - Return Values ΓòÉΓòÉΓòÉ
  3247.  
  3248. The possible return values are the following : 
  3249.  
  3250.  FAX_HEADER_OK 
  3251.  FAX_HERR_NOSETUP 
  3252.  FAX_HERR_STRINGTOOLONG 
  3253.  
  3254.  
  3255. ΓòÉΓòÉΓòÉ <hidden> SetSenderName - Usage ΓòÉΓòÉΓòÉ
  3256.  
  3257. Use this method to set the sender name for the current header. 
  3258.  
  3259.  
  3260. ΓòÉΓòÉΓòÉ <hidden> SetSenderName - Related methods ΓòÉΓòÉΓòÉ
  3261.  
  3262.   GetSenderName 
  3263.  
  3264.  
  3265. ΓòÉΓòÉΓòÉ 4.13. SetSenderFax ΓòÉΓòÉΓòÉ
  3266.  
  3267.  Function Syntax 
  3268.  Parameters 
  3269.  Return Values 
  3270.  Usage 
  3271.  Related methods 
  3272.  
  3273.  
  3274. ΓòÉΓòÉΓòÉ <hidden> SetSenderFax - Function Syntax ΓòÉΓòÉΓòÉ
  3275.  
  3276. /************************************
  3277. /* The SetSenderFax method sets
  3278. /* the sender fax number in the object data.
  3279. /************************************
  3280.  
  3281. APIRET rc ;
  3282. FaxJobHeader * self ;
  3283. PSZ pszSenderFax;
  3284.  
  3285. rc = FaxJobHeader_SetSenderFax ( self, pszSenderFax) ;
  3286.  
  3287.  
  3288. ΓòÉΓòÉΓòÉ <hidden> SetSenderFax - Parameters ΓòÉΓòÉΓòÉ
  3289.  
  3290.  self (FaxJobHeader *) - input 
  3291.      Fax job header object 
  3292.  
  3293.  pszSenderFax (PSZ) 
  3294.      Pointer to the sender fax number string. 
  3295.  
  3296.  
  3297. ΓòÉΓòÉΓòÉ <hidden> SetSenderFax - Return Values ΓòÉΓòÉΓòÉ
  3298.  
  3299. The possible return values are the following : 
  3300.  
  3301.  FAX_HEADER_OK 
  3302.  FAX_HERR_NOSETUP 
  3303.  FAX_HERR_STRINGTOOLONG 
  3304.  
  3305.  
  3306. ΓòÉΓòÉΓòÉ <hidden> SetSenderFax - Usage ΓòÉΓòÉΓòÉ
  3307.  
  3308. Use this method to set the sender fax number for the current header. 
  3309.  
  3310.  
  3311. ΓòÉΓòÉΓòÉ <hidden> SetSenderFax - Related methods ΓòÉΓòÉΓòÉ
  3312.  
  3313.   GetSenderFax 
  3314.  
  3315.  
  3316. ΓòÉΓòÉΓòÉ 4.14. SetSenderPhone ΓòÉΓòÉΓòÉ
  3317.  
  3318.  Function Syntax 
  3319.  Parameters 
  3320.  Return Values 
  3321.  Usage 
  3322.  Related methods 
  3323.  
  3324.  
  3325. ΓòÉΓòÉΓòÉ <hidden> SetSenderPhone - Function Syntax ΓòÉΓòÉΓòÉ
  3326.  
  3327. /************************************
  3328. /* The SetSenderPhone method sets
  3329. /* the sender phone number in the object data.
  3330. /************************************
  3331.  
  3332. APIRET rc ;
  3333. FaxJobHeader * self ;
  3334. PSZ pszSenderPhone;
  3335.  
  3336. rc = FaxJobHeader_SetSenderPhone ( self, pszSenderPhone) ;
  3337.  
  3338.  
  3339. ΓòÉΓòÉΓòÉ <hidden> SetSenderPhone - Parameters ΓòÉΓòÉΓòÉ
  3340.  
  3341.  self (FaxJobHeader *) - input 
  3342.      Fax job header object 
  3343.  
  3344.  pszSenderPhone (PSZ) 
  3345.      Pointer to the sender phone number string. 
  3346.  
  3347.  
  3348. ΓòÉΓòÉΓòÉ <hidden> SetSenderPhone - Return Values ΓòÉΓòÉΓòÉ
  3349.  
  3350. The possible return values are the following : 
  3351.  
  3352.  FAX_HEADER_OK 
  3353.  FAX_HERR_NOSETUP 
  3354.  FAX_HERR_STRINGTOOLONG 
  3355.  
  3356.  
  3357. ΓòÉΓòÉΓòÉ <hidden> SetSenderPhone - Usage ΓòÉΓòÉΓòÉ
  3358.  
  3359. Use this method to set the sender phone number for the current header. 
  3360.  
  3361.  
  3362. ΓòÉΓòÉΓòÉ <hidden> SetSenderPhone - Related methods ΓòÉΓòÉΓòÉ
  3363.  
  3364.   GetSenderPhone 
  3365.  
  3366.  
  3367. ΓòÉΓòÉΓòÉ 4.15. SetRecipientName ΓòÉΓòÉΓòÉ
  3368.  
  3369.  Function Syntax 
  3370.  Parameters 
  3371.  Return Values 
  3372.  Usage 
  3373.  Related methods 
  3374.  
  3375.  
  3376. ΓòÉΓòÉΓòÉ <hidden> SetRecipientName - Function Syntax ΓòÉΓòÉΓòÉ
  3377.  
  3378. /************************************
  3379. /* The SetRecipientName method sets
  3380. /* the recipient name in the object data.
  3381. /************************************
  3382.  
  3383. APIRET rc ;
  3384. FaxJobHeader * self ;
  3385. PSZ pszRecipientName;
  3386.  
  3387. rc = FaxJobHeader_SetRecipientName ( self, pszRecipientName) ;
  3388.  
  3389.  
  3390. ΓòÉΓòÉΓòÉ <hidden> SetRecipientName - Parameters ΓòÉΓòÉΓòÉ
  3391.  
  3392.  self (FaxJobHeader *) - input 
  3393.      Fax job header object 
  3394.  
  3395.  pszRecipientName (PSZ) 
  3396.      Pointer to the sender recipient name. 
  3397.  
  3398.  
  3399. ΓòÉΓòÉΓòÉ <hidden> SetRecipientName - Return Values ΓòÉΓòÉΓòÉ
  3400.  
  3401. The possible return values are the following : 
  3402.  
  3403.  FAX_HEADER_OK 
  3404.  FAX_HERR_NOSETUP 
  3405.  FAX_HERR_STRINGTOOLONG 
  3406.  
  3407.  
  3408. ΓòÉΓòÉΓòÉ <hidden> SetRecipientName - Usage ΓòÉΓòÉΓòÉ
  3409.  
  3410. Use this method to set the sender recipient name for the current header. 
  3411.  
  3412.  
  3413. ΓòÉΓòÉΓòÉ <hidden> SetRecipientName - Related methods ΓòÉΓòÉΓòÉ
  3414.  
  3415.   GetRecipientName 
  3416.  
  3417.  
  3418. ΓòÉΓòÉΓòÉ 4.16. SetComment ΓòÉΓòÉΓòÉ
  3419.  
  3420.  Function Syntax 
  3421.  Parameters 
  3422.  Return Values 
  3423.  Usage 
  3424.  Related methods 
  3425.  
  3426.  
  3427. ΓòÉΓòÉΓòÉ <hidden> SetComment - Function Syntax ΓòÉΓòÉΓòÉ
  3428.  
  3429. /************************************
  3430. /* The SetComment method sets
  3431. /* the comment in the object data.
  3432. /************************************
  3433.  
  3434. APIRET rc ;
  3435. FaxJobHeader * self ;
  3436. PSZ pszComment;
  3437.  
  3438. rc = FaxJobHeader_SetComment ( self, pszComment) ;
  3439.  
  3440.  
  3441. ΓòÉΓòÉΓòÉ <hidden> SetComment - Parameters ΓòÉΓòÉΓòÉ
  3442.  
  3443.  self (FaxJobHeader *) - input 
  3444.      Fax job header object 
  3445.  
  3446.  pszComment (PSZ) 
  3447.      Pointer to the comment string. 
  3448.  
  3449.  
  3450. ΓòÉΓòÉΓòÉ <hidden> SetComment - Return Values ΓòÉΓòÉΓòÉ
  3451.  
  3452. The possible return values are the following : 
  3453.  
  3454.  FAX_HEADER_OK 
  3455.  FAX_HERR_NOSETUP 
  3456.  FAX_HERR_STRINGTOOLONG 
  3457.  
  3458.  
  3459. ΓòÉΓòÉΓòÉ <hidden> SetComment - Usage ΓòÉΓòÉΓòÉ
  3460.  
  3461. Use this method to set the comment for the current header. 
  3462.  
  3463.  
  3464. ΓòÉΓòÉΓòÉ <hidden> SetComment - Related methods ΓòÉΓòÉΓòÉ
  3465.  
  3466.   GetComment 
  3467.  
  3468.  
  3469. ΓòÉΓòÉΓòÉ 4.17. Setup ΓòÉΓòÉΓòÉ
  3470.  
  3471.  Function Syntax 
  3472.  Parameters 
  3473.  Return Values 
  3474.  Notes 
  3475.  Usage 
  3476.  
  3477.  
  3478. ΓòÉΓòÉΓòÉ <hidden> Setup - Function Syntax ΓòÉΓòÉΓòÉ
  3479.  
  3480. /************************************
  3481. /* The Setup method initialises
  3482. /* the object according to the user name .
  3483. /************************************
  3484.  
  3485. APIRET rc ;
  3486. FaxJobHeader * self ;
  3487. PSZ pszUserName;
  3488.  
  3489. rc = FaxJob_Setup ( self, pszUserName) ;
  3490.  
  3491.  
  3492. ΓòÉΓòÉΓòÉ <hidden> Setup - Parameters ΓòÉΓòÉΓòÉ
  3493.  
  3494.  self (FaxJobHeader *) - input 
  3495.      Fax job header object 
  3496.  
  3497.  pszUserName (PSZ) 
  3498.      Pointer to the user name . 
  3499.  
  3500.  
  3501. ΓòÉΓòÉΓòÉ <hidden> Setup - Return Values ΓòÉΓòÉΓòÉ
  3502.  
  3503. The possible return values are the following : 
  3504.  
  3505.  FAX_HEADER_OK 
  3506.  FAX_HERR_STRINGTOOLONG 
  3507.  FAX_HERR_NOUSERNAME 
  3508.  
  3509.  
  3510. ΓòÉΓòÉΓòÉ <hidden> Setup - Notes ΓòÉΓòÉΓòÉ
  3511.  
  3512. Mandatory init to manipulate fax header object. It is to be issued after 
  3513. _somNew. If a call to any method is made before calling the Setup the call will 
  3514. return FAX_HERR_NOSETUP. 
  3515.  
  3516. The parameter pszUserName is the name of the owner of the job. No control is 
  3517. made in this version of the API. 
  3518.  
  3519.  
  3520. ΓòÉΓòÉΓòÉ <hidden> Setup - Usage ΓòÉΓòÉΓòÉ
  3521.  
  3522. Call this method to perform the setup of the header before calling any other 
  3523. method. 
  3524.  
  3525.  
  3526. ΓòÉΓòÉΓòÉ 5. Recipient Class ΓòÉΓòÉΓòÉ
  3527.  
  3528. The FaxRecipient class allows to to add, remove and update entries in the 
  3529. Fax/PM 2.0 phone book. 
  3530.  
  3531.  
  3532. ΓòÉΓòÉΓòÉ 5.1. Create ΓòÉΓòÉΓòÉ
  3533.  
  3534.  Function Syntax 
  3535.  Parameters 
  3536.  Return Values 
  3537.  Notes 
  3538.  Usage 
  3539.  Related methods 
  3540.  
  3541.  
  3542. ΓòÉΓòÉΓòÉ <hidden> Create - Function Syntax ΓòÉΓòÉΓòÉ
  3543.  
  3544. /***************************************
  3545. /* The Create method is used to add
  3546. /* a name in the phonebook.
  3547. /***************************************
  3548.  
  3549. APIRET rc ;
  3550. FaxRecipient * self ;
  3551.  
  3552. rc = _Create ( self ) ;
  3553.  
  3554.  
  3555. ΓòÉΓòÉΓòÉ <hidden> Create - Parameters ΓòÉΓòÉΓòÉ
  3556.  
  3557.  self (FaxRecipient *) - input 
  3558.      recipient object 
  3559.  
  3560.  
  3561. ΓòÉΓòÉΓòÉ <hidden> Create - Return Values ΓòÉΓòÉΓòÉ
  3562.  
  3563. The possible return values are the following : 
  3564.  
  3565.  FAX_PHONEBOOKOK 
  3566.  
  3567.  FAX_PHONEBOOKNOTSETUP 
  3568.  
  3569.  FAX_PHONEBOOKINVALID_NAME 
  3570.  
  3571.  FAX_PHONEBOOKINVALID_FAXNUMBER 
  3572.  
  3573.  FAX_PHONEBOOKERROR_UNKNOWN 
  3574.  
  3575.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  3576.  
  3577.  
  3578. ΓòÉΓòÉΓòÉ <hidden> Create - Notes ΓòÉΓòÉΓòÉ
  3579.  
  3580. Before calling this method, the name and phone number must have been properly 
  3581. set using the SetName and SetTel  functions. 
  3582.  
  3583.  
  3584. ΓòÉΓòÉΓòÉ <hidden> Create - Usage ΓòÉΓòÉΓòÉ
  3585.  
  3586. This method is used to add a name into the phonebook. 
  3587.  
  3588.  
  3589. ΓòÉΓòÉΓòÉ <hidden> Create - Related methods ΓòÉΓòÉΓòÉ
  3590.  
  3591.  SetName 
  3592.  SetTel 
  3593.  
  3594.  
  3595. ΓòÉΓòÉΓòÉ 5.2. Delete ΓòÉΓòÉΓòÉ
  3596.  
  3597.  Function Syntax 
  3598.  Parameters 
  3599.  Return Values 
  3600.  Notes 
  3601.  Usage 
  3602.  Related methods 
  3603.  
  3604.  
  3605. ΓòÉΓòÉΓòÉ <hidden> Delete - Function Syntax ΓòÉΓòÉΓòÉ
  3606.  
  3607. /***************************************
  3608. /* The Delete method is used to remove
  3609. /* the current name from the phonebook.
  3610. /***************************************
  3611.  
  3612. APIRET rc ;
  3613. FaxRecipient * self ;
  3614.  
  3615. rc = _Delete ( self ) ;
  3616.  
  3617.  
  3618. ΓòÉΓòÉΓòÉ <hidden> Delete - Parameters ΓòÉΓòÉΓòÉ
  3619.  
  3620.  self (FaxRecipient *) - input 
  3621.      recipient object 
  3622.  
  3623.  
  3624. ΓòÉΓòÉΓòÉ <hidden> Delete - Return Values ΓòÉΓòÉΓòÉ
  3625.  
  3626. The possible return values are the following : 
  3627.  
  3628.  FAX_PHONEBOOKOK 
  3629.  
  3630.  FAX_PHONEBOOKNOTSETUP 
  3631.  
  3632.  FAX_PHONEBOOKERROR_UNKNOWN 
  3633.  
  3634.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  3635.  
  3636.  
  3637. ΓòÉΓòÉΓòÉ <hidden> Delete - Notes ΓòÉΓòÉΓòÉ
  3638.  
  3639. Before calling this method, there must be a current name retrieved with Get or 
  3640. the name of the current name must be set with SetName. 
  3641.  
  3642. All the occurences of this name in this group are deleted. 
  3643.  
  3644. To remove a name that is not the current name, use the DeleteName method. 
  3645.  
  3646.  
  3647. ΓòÉΓòÉΓòÉ <hidden> Delete - Usage ΓòÉΓòÉΓòÉ
  3648.  
  3649. This function removes the current name from the phonebook. 
  3650.  
  3651.  
  3652. ΓòÉΓòÉΓòÉ <hidden> Delete - Related methods ΓòÉΓòÉΓòÉ
  3653.  
  3654.  Get 
  3655.  SetName 
  3656.  
  3657.  
  3658. ΓòÉΓòÉΓòÉ 5.3. DeleteName ΓòÉΓòÉΓòÉ
  3659.  
  3660.  Function Syntax 
  3661.  Parameters 
  3662.  Return Values 
  3663.  Usage 
  3664.  Related methods 
  3665.  
  3666.  
  3667. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Function Syntax ΓòÉΓòÉΓòÉ
  3668.  
  3669. /***************************************
  3670. /* The DeleteName method is used to
  3671. /* remove a name from the phonebook.
  3672. /***************************************
  3673.  
  3674. APIRET rc ;
  3675. FaxRecipient * self ;
  3676. PSZ pszName ;
  3677.  
  3678. rc = _DeleteName ( self, pszName ) ;
  3679.  
  3680.  
  3681. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Parameters ΓòÉΓòÉΓòÉ
  3682.  
  3683.  self (FaxRecipient *) - input 
  3684.      recipient object 
  3685.  
  3686.  pszName (PSZ) - input 
  3687.      name to remove from the phone book 
  3688.  
  3689.  
  3690. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Return Values ΓòÉΓòÉΓòÉ
  3691.  
  3692. The possible return values are the following : 
  3693.  
  3694.  FAX_PHONEBOOKOK 
  3695.  
  3696.  FAX_PHONEBOOKNOTSETUP 
  3697.  
  3698.  FAX_PHONEBOOKERROR_UNKNOWN 
  3699.  
  3700.  FAX_PHONEBOOKERROR_INVALID_PARM 
  3701.  
  3702.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  3703.  
  3704.  
  3705. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Usage ΓòÉΓòÉΓòÉ
  3706.  
  3707. Call this method to remove a name from the phonebook. This method allows you to 
  3708. remove a name without calling the SetName method. 
  3709.  
  3710.  
  3711. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Related methods ΓòÉΓòÉΓòÉ
  3712.  
  3713.  Delete 
  3714.  
  3715.  
  3716. ΓòÉΓòÉΓòÉ 5.4. Get ΓòÉΓòÉΓòÉ
  3717.  
  3718.  Function Syntax 
  3719.  Parameters 
  3720.  Return Values 
  3721.  Usage 
  3722.  Related methods 
  3723.  
  3724.  
  3725. ΓòÉΓòÉΓòÉ <hidden> Get - Function Syntax ΓòÉΓòÉΓòÉ
  3726.  
  3727. /***************************************
  3728. /* The Get method is used to get a
  3729. /* recipient from the phone book.
  3730. /***************************************
  3731.  
  3732. APIRET rc ;
  3733. FaxRecipient * self ;
  3734. PSZ pszName ;
  3735.  
  3736. rc = _Get ( self, pszName ) ;
  3737.  
  3738.  
  3739. ΓòÉΓòÉΓòÉ <hidden> Get - Parameters ΓòÉΓòÉΓòÉ
  3740.  
  3741.  self (FaxRecipient *) - input 
  3742.      recipient object 
  3743.  
  3744.  pszName (PSZ) - input 
  3745.      name to look for 
  3746.  
  3747.  
  3748. ΓòÉΓòÉΓòÉ <hidden> Get - Return Values ΓòÉΓòÉΓòÉ
  3749.  
  3750. The possible return values are the following : 
  3751.  
  3752.  FAX_PHONEBOOKOK 
  3753.  
  3754.  FAX_PHONEBOOKNOTSETUP 
  3755.  
  3756.  FAX_PHONEBOOKERROR_UNKNOWN 
  3757.  
  3758.  FAX_PHONEBOOKERROR_INVALID_PARM 
  3759.  
  3760.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  3761.  
  3762.  
  3763. ΓòÉΓòÉΓòÉ <hidden> Get - Usage ΓòÉΓòÉΓòÉ
  3764.  
  3765. Use this method to get a recipient from the phone book. 
  3766.  
  3767.  
  3768. ΓòÉΓòÉΓòÉ <hidden> Get - Related methods ΓòÉΓòÉΓòÉ
  3769.  
  3770.  Create 
  3771.  Delete 
  3772.  Update 
  3773.  
  3774.  
  3775. ΓòÉΓòÉΓòÉ 5.5. GetActivity ΓòÉΓòÉΓòÉ
  3776.  
  3777.  Function Syntax 
  3778.  Parameters 
  3779.  Return Values 
  3780.  Usage 
  3781.  Related methods 
  3782.  
  3783.  
  3784. ΓòÉΓòÉΓòÉ <hidden> GetActivity - Function Syntax ΓòÉΓòÉΓòÉ
  3785.  
  3786. /***************************************
  3787. /* The GetActivity method is used to
  3788. /* get the activity information
  3789. /* about the recipient.
  3790. /***************************************
  3791.  
  3792. APIRET rc ;
  3793. FaxRecipient * self ;
  3794. PSZ pszBuf ;
  3795. PULONG pulLen ;
  3796.  
  3797. rc = _GetActivity ( self, pszBuf, pulLen ) ;
  3798.  
  3799.  
  3800. ΓòÉΓòÉΓòÉ <hidden> GetActivity - Parameters ΓòÉΓòÉΓòÉ
  3801.  
  3802.  self (FaxRecipient *) - input 
  3803.      recipient object 
  3804.  
  3805.  pszBuffer (PSZ) - output 
  3806.      receives the address information. If this field is NULL, the pulLen 
  3807.      parameter receives the actual length to be returned. 
  3808.  
  3809.  pulLen (PULONG) - input/output 
  3810.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  3811.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  3812.      must contain 0. Then, on output it will receive the size of the required 
  3813.      memory. 
  3814.  
  3815.  
  3816. ΓòÉΓòÉΓòÉ <hidden> GetActivity - Return Values ΓòÉΓòÉΓòÉ
  3817.  
  3818. The possible return values are the following : 
  3819.  
  3820.  FAX_PHONEBOOKOK 
  3821.  
  3822.  FAX_PHONEBOOKNOTSETUP 
  3823.  
  3824.  
  3825. ΓòÉΓòÉΓòÉ <hidden> GetActivity - Usage ΓòÉΓòÉΓòÉ
  3826.  
  3827. Call this function to get information about the activity of the recipient. 
  3828.  
  3829.  
  3830. ΓòÉΓòÉΓòÉ <hidden> GetActivity - Related methods ΓòÉΓòÉΓòÉ
  3831.  
  3832.  SetActivity 
  3833.  
  3834.  
  3835. ΓòÉΓòÉΓòÉ 5.6. GetAddress ΓòÉΓòÉΓòÉ
  3836.  
  3837.  Function Syntax 
  3838.  Parameters 
  3839.  Return Values 
  3840.  Usage 
  3841.  Related methods 
  3842.  
  3843.  
  3844. ΓòÉΓòÉΓòÉ <hidden> GetAddress - Function Syntax ΓòÉΓòÉΓòÉ
  3845.  
  3846. /***************************************
  3847. /* The GetAddress method is used to
  3848. /* get the address of the recipient.
  3849. /***************************************
  3850.  
  3851. APIRET rc ;
  3852. FaxRecipient * self ;
  3853. PSZ pszBuf ;
  3854. PULONG pulLen ;
  3855.  
  3856. rc = _GetAddress ( self, pszBuf, pulLen ) ;
  3857.  
  3858.  
  3859. ΓòÉΓòÉΓòÉ <hidden> GetAddress - Parameters ΓòÉΓòÉΓòÉ
  3860.  
  3861.  self (FaxRecipient *) - input 
  3862.      recipient object 
  3863.  
  3864.  pszBuffer (PSZ) - output 
  3865.      receives the address information. If this field is NULL, the pulLen 
  3866.      parameter receives the actual length to be returned. 
  3867.  
  3868.  pulLen (PULONG) - input/output 
  3869.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  3870.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  3871.      must contain 0. Then, on output it will receive the size of the required 
  3872.      memory. 
  3873.  
  3874.  
  3875. ΓòÉΓòÉΓòÉ <hidden> GetAddress - Return Values ΓòÉΓòÉΓòÉ
  3876.  
  3877. The possible return values are the following : 
  3878.  
  3879.  FAX_PHONEBOOKOK 
  3880.  
  3881.  FAX_PHONEBOOKNOTSETUP 
  3882.  
  3883.  
  3884. ΓòÉΓòÉΓòÉ <hidden> GetAddress - Usage ΓòÉΓòÉΓòÉ
  3885.  
  3886. Call this function to get the address of the recipient. 
  3887.  
  3888.  
  3889. ΓòÉΓòÉΓòÉ <hidden> GetAddress - Related methods ΓòÉΓòÉΓòÉ
  3890.  
  3891.  SetAddress 
  3892.  
  3893.  
  3894. ΓòÉΓòÉΓòÉ 5.7. GetAllNames ΓòÉΓòÉΓòÉ
  3895.  
  3896.  Function Syntax 
  3897.  Parameters 
  3898.  Return Values 
  3899.  Usage 
  3900.  Related methods 
  3901.  
  3902.  
  3903. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Function Syntax ΓòÉΓòÉΓòÉ
  3904.  
  3905. /***************************************
  3906. /* The GetAllNames method is used to
  3907. /* get the list of all the names in
  3908. /* the phonebook.
  3909. /***************************************
  3910.  
  3911. APIRET rc ;
  3912. FaxRecipient * self ;
  3913. PSZ pszBuf ;
  3914. PULONG pulLen ;
  3915.  
  3916. rc = _GetAllNames ( self, pszVal, pulLen ) ;
  3917.  
  3918.  
  3919. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Parameters ΓòÉΓòÉΓòÉ
  3920.  
  3921.  self (FaxRecipient *) - input 
  3922.      recipient object 
  3923.  
  3924.  pszBuffer (PSZ) - output 
  3925.      receives the list of names. If this field is NULL, the pulLen parameter 
  3926.      receives the actual length to be returned. 
  3927.      The list is terminated by a double NULL character. All the names in the 
  3928.      list are separated by NULL characters. 
  3929.  
  3930.  pulLen (PULONG) - input/output 
  3931.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  3932.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  3933.      must contain 0. Then, on output it will receive the size of the required 
  3934.      memory. 
  3935.  
  3936.  
  3937. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Return Values ΓòÉΓòÉΓòÉ
  3938.  
  3939. The possible return values are the following : 
  3940.  
  3941.  FAX_PHONEBOOKOK 
  3942.  
  3943.  FAX_PHONEBOOKNOTSETUP 
  3944.  
  3945.  FAX_PHONEBOOKERROR_UNKNOWN 
  3946.  
  3947.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  3948.  
  3949.  
  3950. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Usage ΓòÉΓòÉΓòÉ
  3951.  
  3952. Call this method to get all the names that are stored in the phonebook. 
  3953.  
  3954.  
  3955. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Related methods ΓòÉΓòÉΓòÉ
  3956.  
  3957. none 
  3958.  
  3959.  
  3960. ΓòÉΓòÉΓòÉ 5.8. GetAreaCode ΓòÉΓòÉΓòÉ
  3961.  
  3962.  Function Syntax 
  3963.  Parameters 
  3964.  Return Values 
  3965.  Usage 
  3966.  Related methods 
  3967.  
  3968.  
  3969. ΓòÉΓòÉΓòÉ <hidden> GetAreaCode - Function Syntax ΓòÉΓòÉΓòÉ
  3970.  
  3971. /***************************************
  3972. /* The GetAreaCode method is used to
  3973. /* get the area code of the recipient.
  3974. /***************************************
  3975.  
  3976. APIRET rc ;
  3977. FaxRecipient * self ;
  3978. PSZ pszBuf ;
  3979. PULONG pulLen ;
  3980.  
  3981. rc = _GetAreaCode ( self, pszBuf, pulLen ) ;
  3982.  
  3983.  
  3984. ΓòÉΓòÉΓòÉ <hidden> GetAreaCode - Parameters ΓòÉΓòÉΓòÉ
  3985.  
  3986.  self (FaxRecipient *) - input 
  3987.      recipient object 
  3988.  
  3989.  pszBuffer (PSZ) - output 
  3990.      receives the area code information. If this field is NULL, the pulLen 
  3991.      parameter receives the actual length to be returned. 
  3992.  
  3993.  pulLen (PULONG) - input/output 
  3994.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  3995.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  3996.      must contain 0. Then, on output it will receive the size of the required 
  3997.      memory. 
  3998.  
  3999.  
  4000. ΓòÉΓòÉΓòÉ <hidden> GetAreaCode - Return Values ΓòÉΓòÉΓòÉ
  4001.  
  4002. The possible return values are the following : 
  4003.  
  4004.  FAX_PHONEBOOKOK 
  4005.  
  4006.  FAX_PHONEBOOKNOTSETUP 
  4007.  
  4008.  
  4009. ΓòÉΓòÉΓòÉ <hidden> GetAreaCode - Usage ΓòÉΓòÉΓòÉ
  4010.  
  4011. Call this method to get the area code of the recipient. 
  4012.  
  4013.  
  4014. ΓòÉΓòÉΓòÉ <hidden> GetAreaCode - Related methods ΓòÉΓòÉΓòÉ
  4015.  
  4016.  SetAreaCode 
  4017.  
  4018.  
  4019. ΓòÉΓòÉΓòÉ 5.9. GetCity ΓòÉΓòÉΓòÉ
  4020.  
  4021.  Function Syntax 
  4022.  Parameters 
  4023.  Return Values 
  4024.  Usage 
  4025.  Related methods 
  4026.  
  4027.  
  4028. ΓòÉΓòÉΓòÉ <hidden> GetCity - Function Syntax ΓòÉΓòÉΓòÉ
  4029.  
  4030. /***************************************
  4031. /* The GetCity method is used to
  4032. /* get the city of the recipient.
  4033. /***************************************
  4034.  
  4035. APIRET rc ;
  4036. FaxRecipient * self ;
  4037. PSZ pszBuf ;
  4038. PULONG pulLen ;
  4039.  
  4040. rc = _GetCity ( self, pszBuf, pulLen ) ;
  4041.  
  4042.  
  4043. ΓòÉΓòÉΓòÉ <hidden> GetCity - Parameters ΓòÉΓòÉΓòÉ
  4044.  
  4045.  self (FaxRecipient *) - input 
  4046.      recipient object 
  4047.  
  4048.  pszBuffer (PSZ) - output 
  4049.      receives the city information. If this field is NULL, the pulLen parameter 
  4050.      receives the actual length to be returned. 
  4051.  
  4052.  pulLen (PULONG) - input/output 
  4053.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4054.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4055.      must contain 0. Then, on output it will receive the size of the required 
  4056.      memory. 
  4057.  
  4058.  
  4059. ΓòÉΓòÉΓòÉ <hidden> GetCity - Return Values ΓòÉΓòÉΓòÉ
  4060.  
  4061. The possible return values are the following : 
  4062.  
  4063.  FAX_PHONEBOOKOK 
  4064.  
  4065.  FAX_PHONEBOOKNOTSETUP 
  4066.  
  4067.  
  4068. ΓòÉΓòÉΓòÉ <hidden> GetCity - Usage ΓòÉΓòÉΓòÉ
  4069.  
  4070. Call this method to get the city of the recipient. 
  4071.  
  4072.  
  4073. ΓòÉΓòÉΓòÉ <hidden> GetCity - Related methods ΓòÉΓòÉΓòÉ
  4074.  
  4075.  SetCity 
  4076.  
  4077.  
  4078. ΓòÉΓòÉΓòÉ 5.10. GetCompany ΓòÉΓòÉΓòÉ
  4079.  
  4080.  Function Syntax 
  4081.  Parameters 
  4082.  Return Values 
  4083.  Usage 
  4084.  Related methods 
  4085.  
  4086.  
  4087. ΓòÉΓòÉΓòÉ <hidden> GetCompany - Function Syntax ΓòÉΓòÉΓòÉ
  4088.  
  4089. /***************************************
  4090. /* The GetCompany method is used to
  4091. /* get the company of the recipient.
  4092. /***************************************
  4093.  
  4094. APIRET rc ;
  4095. FaxRecipient * self ;
  4096. PSZ pszBuf ;
  4097. PULONG pulLen ;
  4098.  
  4099. rc = _GetCompany ( self, pszBuf, pulLen ) ;
  4100.  
  4101.  
  4102. ΓòÉΓòÉΓòÉ <hidden> GetCompany - Parameters ΓòÉΓòÉΓòÉ
  4103.  
  4104.  self (FaxRecipient *) - input 
  4105.      recipient object 
  4106.  
  4107.  pszBuffer (PSZ) - output 
  4108.      receives the company information. If this field is NULL, the pulLen 
  4109.      parameter receives the actual length to be returned. 
  4110.  
  4111.  pulLen (PULONG) - input/output 
  4112.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4113.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4114.      must contain 0. Then, on output it will receive the size of the required 
  4115.      memory. 
  4116.  
  4117.  
  4118. ΓòÉΓòÉΓòÉ <hidden> GetCompany - Return Values ΓòÉΓòÉΓòÉ
  4119.  
  4120. The possible return values are the following : 
  4121.  
  4122.  FAX_PHONEBOOKOK 
  4123.  
  4124.  FAX_PHONEBOOKNOTSETUP 
  4125.  
  4126.  
  4127. ΓòÉΓòÉΓòÉ <hidden> GetCompany - Usage ΓòÉΓòÉΓòÉ
  4128.  
  4129. Call this method to get the company of the recipient. 
  4130.  
  4131.  
  4132. ΓòÉΓòÉΓòÉ <hidden> GetCompany - Related methods ΓòÉΓòÉΓòÉ
  4133.  
  4134.  SetCompany 
  4135.  
  4136.  
  4137. ΓòÉΓòÉΓòÉ 5.11. GetCountry ΓòÉΓòÉΓòÉ
  4138.  
  4139.  Function Syntax 
  4140.  Parameters 
  4141.  Return Values 
  4142.  Usage 
  4143.  Related methods 
  4144.  
  4145.  
  4146. ΓòÉΓòÉΓòÉ <hidden> GetCountry - Function Syntax ΓòÉΓòÉΓòÉ
  4147.  
  4148. /***************************************
  4149. /* The GetCountry method is used to
  4150. /* get the country of the recipient.
  4151. /***************************************
  4152.  
  4153. APIRET rc ;
  4154. FaxRecipient * self ;
  4155. PSZ pszBuf ;
  4156. PULONG pulLen ;
  4157.  
  4158. rc = _GetCountry ( self, pszBuf, pulLen ) ;
  4159.  
  4160.  
  4161. ΓòÉΓòÉΓòÉ <hidden> GetCountry - Parameters ΓòÉΓòÉΓòÉ
  4162.  
  4163.  self (FaxRecipient *) - input 
  4164.      recipient object 
  4165.  
  4166.  pszBuffer (PSZ) - output 
  4167.      receives the country information. If this field is NULL, the pulLen 
  4168.      parameter receives the actual length to be returned. 
  4169.  
  4170.  pulLen (PULONG) - input/output 
  4171.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4172.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4173.      must contain 0. Then, on output it will receive the size of the required 
  4174.      memory. 
  4175.  
  4176.  
  4177. ΓòÉΓòÉΓòÉ <hidden> GetCountry - Return Values ΓòÉΓòÉΓòÉ
  4178.  
  4179. The possible return values are the following : 
  4180.  
  4181.  FAX_PHONEBOOKOK 
  4182.  
  4183.  FAX_PHONEBOOKNOTSETUP 
  4184.  
  4185.  
  4186. ΓòÉΓòÉΓòÉ <hidden> GetCountry - Usage ΓòÉΓòÉΓòÉ
  4187.  
  4188. Call this method to get the country of the recipient. 
  4189.  
  4190.  
  4191. ΓòÉΓòÉΓòÉ <hidden> GetCountry - Related methods ΓòÉΓòÉΓòÉ
  4192.  
  4193.  SetCountry 
  4194.  
  4195.  
  4196. ΓòÉΓòÉΓòÉ 5.12. GetCountryCode ΓòÉΓòÉΓòÉ
  4197.  
  4198.  Function Syntax 
  4199.  Parameters 
  4200.  Return Values 
  4201.  Usage 
  4202.  Related methods 
  4203.  
  4204.  
  4205. ΓòÉΓòÉΓòÉ <hidden> GetCountryCode - Function Syntax ΓòÉΓòÉΓòÉ
  4206.  
  4207. /***************************************
  4208. /* The GetCountryCode  method is used to
  4209. /* get the country code of the recipient
  4210. /***************************************
  4211.  
  4212. APIRET rc ;
  4213. FaxRecipient * self ;
  4214. PSZ pszBuf ;
  4215. PULONG pulLen ;
  4216.  
  4217. rc = _GetCountryCode ( self, pszBuf, pulLen ) ;
  4218.  
  4219.  
  4220. ΓòÉΓòÉΓòÉ <hidden> GetCountryCode - Parameters ΓòÉΓòÉΓòÉ
  4221.  
  4222.  self (FaxRecipient *) - input 
  4223.      recipient object 
  4224.  
  4225.  pszBuffer (PSZ) - output 
  4226.      receives the country code information. If this field is NULL, the pulLen 
  4227.      parameter receives the actual length to be returned. 
  4228.  
  4229.  pulLen (PULONG) - input/output 
  4230.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4231.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4232.      must contain 0. Then, on output it will receive the size of the required 
  4233.      memory. 
  4234.  
  4235.  
  4236. ΓòÉΓòÉΓòÉ <hidden> GetCountryCode - Return Values ΓòÉΓòÉΓòÉ
  4237.  
  4238. The possible return values are the following : 
  4239.  
  4240.  FAX_PHONEBOOKOK 
  4241.  
  4242.  FAX_PHONEBOOKNOTSETUP 
  4243.  
  4244.  
  4245. ΓòÉΓòÉΓòÉ <hidden> GetCountryCode - Usage ΓòÉΓòÉΓòÉ
  4246.  
  4247. Call this method to get the country code of the recipient. 
  4248.  
  4249.  
  4250. ΓòÉΓòÉΓòÉ <hidden> GetCountryCode - Related methods ΓòÉΓòÉΓòÉ
  4251.  
  4252.  SetCountryCode 
  4253.  
  4254.  
  4255. ΓòÉΓòÉΓòÉ 5.13. GetDivision ΓòÉΓòÉΓòÉ
  4256.  
  4257.  Function Syntax 
  4258.  Parameters 
  4259.  Return Values 
  4260.  Usage 
  4261.  Related methods 
  4262.  
  4263.  
  4264. ΓòÉΓòÉΓòÉ <hidden> GetDivision - Function Syntax ΓòÉΓòÉΓòÉ
  4265.  
  4266. /***************************************
  4267. /* The GetDivision  method is used to
  4268. /* get the division of the recipient.
  4269. /***************************************
  4270.  
  4271. APIRET rc ;
  4272. FaxRecipient * self ;
  4273. PSZ pszBuf ;
  4274. PULONG pulLen ;
  4275.  
  4276. rc = _GetDivision ( self, pszBuf, pulLen ) ;
  4277.  
  4278.  
  4279. ΓòÉΓòÉΓòÉ <hidden> GetDivision - Parameters ΓòÉΓòÉΓòÉ
  4280.  
  4281.  self (FaxRecipient *) - input 
  4282.      recipient object 
  4283.  
  4284.  pszBuffer (PSZ) - output 
  4285.      receives the division information. If this field is NULL, the pulLen 
  4286.      parameter receives the actual length to be returned. 
  4287.  
  4288.  pulLen (PULONG) - input/output 
  4289.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4290.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4291.      must contain 0. Then, on output it will receive the size of the required 
  4292.      memory. 
  4293.  
  4294.  
  4295. ΓòÉΓòÉΓòÉ <hidden> GetDivision - Return Values ΓòÉΓòÉΓòÉ
  4296.  
  4297. The possible return values are the following : 
  4298.  
  4299.  FAX_PHONEBOOKOK 
  4300.  
  4301.  FAX_PHONEBOOKNOTSETUP 
  4302.  
  4303.  
  4304. ΓòÉΓòÉΓòÉ <hidden> GetDivision - Usage ΓòÉΓòÉΓòÉ
  4305.  
  4306. Call this method to get the division of the recipient. 
  4307.  
  4308.  
  4309. ΓòÉΓòÉΓòÉ <hidden> GetDivision - Related methods ΓòÉΓòÉΓòÉ
  4310.  
  4311.  SetDivision 
  4312.  
  4313.  
  4314. ΓòÉΓòÉΓòÉ 5.14. GetExtension ΓòÉΓòÉΓòÉ
  4315.  
  4316.  Function Syntax 
  4317.  Parameters 
  4318.  Return Values 
  4319.  Usage 
  4320.  Related methods 
  4321.  
  4322.  
  4323. ΓòÉΓòÉΓòÉ <hidden> GetExtension - Function Syntax ΓòÉΓòÉΓòÉ
  4324.  
  4325. /***************************************
  4326. /* The GetExtension method is used to
  4327. /* get the extension information
  4328. /* about the recipient.
  4329. /***************************************
  4330.  
  4331. APIRET rc ;
  4332. FaxRecipient * self ;
  4333. PSZ pszBuf ;
  4334. PULONG pulLen ;
  4335.  
  4336. rc = _GetExtension ( self, pszBuf, pulLen ) ;
  4337.  
  4338.  
  4339. ΓòÉΓòÉΓòÉ <hidden> GetExtension - Parameters ΓòÉΓòÉΓòÉ
  4340.  
  4341.  self (FaxRecipient *) - input 
  4342.      recipient object 
  4343.  
  4344.  pszBuffer (PSZ) - output 
  4345.      receives the extension information. If this field is NULL, the pulLen 
  4346.      parameter receives the actual length to be returned. 
  4347.  
  4348.  pulLen (PULONG) - input/output 
  4349.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4350.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4351.      must contain 0. Then, on output it will receive the size of the required 
  4352.      memory. 
  4353.  
  4354.  
  4355. ΓòÉΓòÉΓòÉ <hidden> GetExtension - Return Values ΓòÉΓòÉΓòÉ
  4356.  
  4357. The possible return values are the following : 
  4358.  
  4359.  FAX_PHONEBOOKOK 
  4360.  
  4361.  FAX_PHONEBOOKNOTSETUP 
  4362.  
  4363.  
  4364. ΓòÉΓòÉΓòÉ <hidden> GetExtension - Usage ΓòÉΓòÉΓòÉ
  4365.  
  4366. Call this method to get the extension of the recipient. 
  4367.  
  4368.  
  4369. ΓòÉΓòÉΓòÉ <hidden> GetExtension - Related methods ΓòÉΓòÉΓòÉ
  4370.  
  4371.  SetExtension 
  4372.  
  4373.  
  4374. ΓòÉΓòÉΓòÉ 5.15. GetExternalCall ΓòÉΓòÉΓòÉ
  4375.  
  4376.  Function Syntax 
  4377.  Parameters 
  4378.  Return Values 
  4379.  Usage 
  4380.  Related methods 
  4381.  
  4382.  
  4383. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Function Syntax ΓòÉΓòÉΓòÉ
  4384.  
  4385. /***************************************
  4386. /* The GetExternalCall method is used to
  4387. /* get the external call flag
  4388. /* about the recipient.
  4389. /***************************************
  4390.  
  4391. APIRET rc ;
  4392. FaxRecipient * self ;
  4393. PULONG pulExtCall ;
  4394.  
  4395. rc = _GetExternalCall ( ulExtCall ) ;
  4396.  
  4397.  
  4398. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Parameters ΓòÉΓòÉΓòÉ
  4399.  
  4400.  self (FaxRecipient *) - input 
  4401.      recipient object 
  4402.  
  4403.  pulExtCall (PULONG) - output receives the external call flag. 
  4404.  
  4405.  
  4406. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Return Values ΓòÉΓòÉΓòÉ
  4407.  
  4408. The possible return values are the following : 
  4409.  
  4410.  FAX_PHONEBOOKOK 
  4411.  
  4412.  FAX_PHONEBOOKNOTSETUP 
  4413.  
  4414.  
  4415. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Usage ΓòÉΓòÉΓòÉ
  4416.  
  4417. Call this method to get the external call flag of the recipient. 
  4418.  
  4419.  
  4420. ΓòÉΓòÉΓòÉ <hidden> GetExternalCall - Related methods ΓòÉΓòÉΓòÉ
  4421.  
  4422.  SetExternalCall 
  4423.  
  4424.  
  4425. ΓòÉΓòÉΓòÉ 5.16. GetName ΓòÉΓòÉΓòÉ
  4426.  
  4427.  Function Syntax 
  4428.  Parameters 
  4429.  Return Values 
  4430.  Usage 
  4431.  Related methods 
  4432.  
  4433.  
  4434. ΓòÉΓòÉΓòÉ <hidden> GetName - Function Syntax ΓòÉΓòÉΓòÉ
  4435.  
  4436. /***************************************
  4437. /* The GetName method is used to
  4438. /* get the name of the recipient.
  4439. /***************************************
  4440.  
  4441. APIRET rc ;
  4442. FaxRecipient * self ;
  4443. PSZ pszBuf ;
  4444. PULONG pulLen ;
  4445.  
  4446. rc = _GetName ( self, pszBuf, pulLen ) ;
  4447.  
  4448.  
  4449. ΓòÉΓòÉΓòÉ <hidden> GetName - Parameters ΓòÉΓòÉΓòÉ
  4450.  
  4451.  self (FaxRecipient *) - input 
  4452.      recipient object 
  4453.  
  4454.  pszBuffer (PSZ) - output 
  4455.      receives the name. If this field is NULL, the pulLen parameter receives 
  4456.      the actual length to be returned. 
  4457.  
  4458.  pulLen (PULONG) - input/output 
  4459.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4460.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4461.      must contain 0. Then, on output it will receive the size of the required 
  4462.      memory. 
  4463.  
  4464.  
  4465. ΓòÉΓòÉΓòÉ <hidden> GetName - Return Values ΓòÉΓòÉΓòÉ
  4466.  
  4467. The possible return values are the following : 
  4468.  
  4469.  FAX_PHONEBOOKOK 
  4470.  
  4471.  FAX_PHONEBOOKNOTSETUP 
  4472.  
  4473.  
  4474. ΓòÉΓòÉΓòÉ <hidden> GetName - Usage ΓòÉΓòÉΓòÉ
  4475.  
  4476. Call this method to get the name of the recipient. 
  4477.  
  4478.  
  4479. ΓòÉΓòÉΓòÉ <hidden> GetName - Related methods ΓòÉΓòÉΓòÉ
  4480.  
  4481.  SetName 
  4482.  
  4483.  
  4484. ΓòÉΓòÉΓòÉ 5.17. GetOwner ΓòÉΓòÉΓòÉ
  4485.  
  4486.  Function Syntax 
  4487.  Parameters 
  4488.  Return Values 
  4489.  Usage 
  4490.  Related methods 
  4491.  
  4492.  
  4493. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Function Syntax ΓòÉΓòÉΓòÉ
  4494.  
  4495. /***************************************
  4496. /* The GetOwner method is used to
  4497. /* get the name of the recipient entry's
  4498. /* owner.
  4499. /***************************************
  4500.  
  4501. APIRET rc ;
  4502. FaxRecipient * self ;
  4503. PSZ pszBuf ;
  4504. PULONG pulLen ;
  4505.  
  4506. rc = _GetOwner ( self, pszBuf, pulLen ) ;
  4507.  
  4508.  
  4509. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Parameters ΓòÉΓòÉΓòÉ
  4510.  
  4511.  self (FaxRecipient *) - input 
  4512.      recipient object 
  4513.  
  4514.  pszBuffer (PSZ) - output 
  4515.      receives the owner. If this field is NULL, the pulLen parameter receives 
  4516.      the actual length to be returned. 
  4517.  
  4518.  pulLen (PULONG) - input/output 
  4519.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4520.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4521.      must contain 0. Then, on output it will receive the size of the required 
  4522.      memory. 
  4523.  
  4524.  
  4525. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Return Values ΓòÉΓòÉΓòÉ
  4526.  
  4527. The possible return values are the following : 
  4528.  
  4529.  FAX_PHONEBOOKOK 
  4530.  
  4531.  FAX_PHONEBOOKNOTSETUP 
  4532.  
  4533.  
  4534. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Usage ΓòÉΓòÉΓòÉ
  4535.  
  4536. Call this method to get the name of the recipient. 
  4537.  
  4538.  
  4539. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Related methods ΓòÉΓòÉΓòÉ
  4540.  
  4541.  SetOwner 
  4542.  
  4543.  
  4544. ΓòÉΓòÉΓòÉ 5.18. GetState ΓòÉΓòÉΓòÉ
  4545.  
  4546.  Function Syntax 
  4547.  Parameters 
  4548.  Return Values 
  4549.  Usage 
  4550.  Related methods 
  4551.  
  4552.  
  4553. ΓòÉΓòÉΓòÉ <hidden> GetState - Function Syntax ΓòÉΓòÉΓòÉ
  4554.  
  4555. /***************************************
  4556. /* The GetState method is used to
  4557. /* get the state information
  4558. /* about the recipient.
  4559. /***************************************
  4560.  
  4561. APIRET rc ;
  4562. FaxRecipient * self ;
  4563. PSZ pszBuf ;
  4564. PULONG pulLen ;
  4565.  
  4566. rc = _GetState ( self, pszBuf, pulLen ) ;
  4567.  
  4568.  
  4569. ΓòÉΓòÉΓòÉ <hidden> GetState - Parameters ΓòÉΓòÉΓòÉ
  4570.  
  4571.  self (FaxRecipient *) - input 
  4572.      recipient object 
  4573.  
  4574.  pszBuffer (PSZ) - output 
  4575.      receives the state. If this field is NULL, the pulLen parameter receives 
  4576.      the actual length to be returned. 
  4577.  
  4578.  pulLen (PULONG) - input/output 
  4579.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4580.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4581.      must contain 0. Then, on output it will receive the size of the required 
  4582.      memory. 
  4583.  
  4584.  
  4585. ΓòÉΓòÉΓòÉ <hidden> GetState - Return Values ΓòÉΓòÉΓòÉ
  4586.  
  4587. The possible return values are the following : 
  4588.  
  4589.  FAX_PHONEBOOKOK 
  4590.  
  4591.  FAX_PHONEBOOKNOTSETUP 
  4592.  
  4593.  
  4594. ΓòÉΓòÉΓòÉ <hidden> GetState - Usage ΓòÉΓòÉΓòÉ
  4595.  
  4596. Call this method to get the state of the recipient. 
  4597.  
  4598.  
  4599. ΓòÉΓòÉΓòÉ <hidden> GetState - Related methods ΓòÉΓòÉΓòÉ
  4600.  
  4601.  SetState 
  4602.  
  4603.  
  4604. ΓòÉΓòÉΓòÉ 5.19. GetTel ΓòÉΓòÉΓòÉ
  4605.  
  4606.  Function Syntax 
  4607.  Parameters 
  4608.  Return Values 
  4609.  Usage 
  4610.  Related methods 
  4611.  
  4612.  
  4613. ΓòÉΓòÉΓòÉ <hidden> GetTel - Function Syntax ΓòÉΓòÉΓòÉ
  4614.  
  4615. /***************************************
  4616. /* The GetTel method is used to
  4617. /* get the fax telephone number
  4618. /* of the recipient.
  4619. /***************************************
  4620.  
  4621. APIRET rc ;
  4622. FaxRecipient * self ;
  4623. PSZ pszBuf ;
  4624. PULONG pulLen ;
  4625.  
  4626. rc = _GetTel ( self, pszBuf, pulLen ) ;
  4627.  
  4628.  
  4629. ΓòÉΓòÉΓòÉ <hidden> GetTel - Parameters ΓòÉΓòÉΓòÉ
  4630.  
  4631.  self (FaxRecipient *) - input 
  4632.      recipient object 
  4633.  
  4634.  pszBuffer (PSZ) - output 
  4635.      receives the fax telephone number. If this field is NULL, the pulLen 
  4636.      parameter receives the actual length to be returned. 
  4637.  
  4638.  pulLen (PULONG) - input/output 
  4639.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4640.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4641.      must contain 0. Then, on output it will receive the size of the required 
  4642.      memory. 
  4643.  
  4644.  
  4645. ΓòÉΓòÉΓòÉ <hidden> GetTel - Return Values ΓòÉΓòÉΓòÉ
  4646.  
  4647. The possible return values are the following : 
  4648.  
  4649.  FAX_PHONEBOOKOK 
  4650.  
  4651.  FAX_PHONEBOOKNOTSETUP 
  4652.  
  4653.  
  4654. ΓòÉΓòÉΓòÉ <hidden> GetTel - Usage ΓòÉΓòÉΓòÉ
  4655.  
  4656. Call this method to get the fax telephone number of the recipient. 
  4657.  
  4658.  
  4659. ΓòÉΓòÉΓòÉ <hidden> GetTel - Related methods ΓòÉΓòÉΓòÉ
  4660.  
  4661.  SetTel 
  4662.  
  4663.  
  4664. ΓòÉΓòÉΓòÉ 5.20. GetZip ΓòÉΓòÉΓòÉ
  4665.  
  4666.  Function Syntax 
  4667.  Parameters 
  4668.  Return Values 
  4669.  Usage 
  4670.  Related methods 
  4671.  
  4672.  
  4673. ΓòÉΓòÉΓòÉ <hidden> GetZip - Function Syntax ΓòÉΓòÉΓòÉ
  4674.  
  4675. /***************************************
  4676. /* The GetZip method is used to
  4677. /* get the ZIP code of the recipient.
  4678. /***************************************
  4679.  
  4680. APIRET rc ;
  4681. FaxRecipient * self ;
  4682. PSZ pszBuf ;
  4683. PULONG pulLen ;
  4684.  
  4685. rc = _GetZip ( self, pszBuf, pulLen ) ;
  4686.  
  4687.  
  4688. ΓòÉΓòÉΓòÉ <hidden> GetZip - Parameters ΓòÉΓòÉΓòÉ
  4689.  
  4690.  self (FaxRecipient *) - input 
  4691.      recipient object 
  4692.  
  4693.  pszBuffer (PSZ) - output 
  4694.      receives the ZIP code. If this field is NULL, the pulLen parameter 
  4695.      receives the actual length to be returned. 
  4696.  
  4697.  pulLen (PULONG) - input/output 
  4698.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  4699.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  4700.      must contain 0. Then, on output it will receive the size of the required 
  4701.      memory. 
  4702.  
  4703.  
  4704. ΓòÉΓòÉΓòÉ <hidden> GetZip - Return Values ΓòÉΓòÉΓòÉ
  4705.  
  4706. The possible return values are the following : 
  4707.  
  4708.  FAX_PHONEBOOKOK 
  4709.  
  4710.  FAX_PHONEBOOKNOTSETUP 
  4711.  
  4712.  
  4713. ΓòÉΓòÉΓòÉ <hidden> GetZip - Usage ΓòÉΓòÉΓòÉ
  4714.  
  4715. Call this method to get the ZIP code of the recipient. 
  4716.  
  4717.  
  4718. ΓòÉΓòÉΓòÉ <hidden> GetZip - Related methods ΓòÉΓòÉΓòÉ
  4719.  
  4720.  SetZip 
  4721.  
  4722.  
  4723. ΓòÉΓòÉΓòÉ 5.21. SetActivity ΓòÉΓòÉΓòÉ
  4724.  
  4725.  Function Syntax 
  4726.  Parameters 
  4727.  Return Values 
  4728.  Usage 
  4729.  Related methods 
  4730.  
  4731.  
  4732. ΓòÉΓòÉΓòÉ <hidden> SetActivity - Function Syntax ΓòÉΓòÉΓòÉ
  4733.  
  4734. /***************************************
  4735. /* The SetActivity method is used to
  4736. /* set the activity information
  4737. /* about the recipient.
  4738. /***************************************
  4739.  
  4740. APIRET rc ;
  4741. FaxRecipient * self ;
  4742. PSZ pszBuf ;
  4743. PULONG pulLen ;
  4744.  
  4745. rc = _SetActivity ( pszBuf ) ;
  4746.  
  4747.  
  4748. ΓòÉΓòÉΓòÉ <hidden> SetActivity - Parameters ΓòÉΓòÉΓòÉ
  4749.  
  4750.  self (FaxRecipient *) - input 
  4751.      recipient object 
  4752.  
  4753.  pszBuf (PSZ) - input 
  4754.      receives the information to set. The information is NULL terminated. 
  4755.  
  4756.  
  4757. ΓòÉΓòÉΓòÉ <hidden> SetActivity - Return Values ΓòÉΓòÉΓòÉ
  4758.  
  4759. The possible return values are the following : 
  4760.  
  4761.  FAX_PHONEBOOKOK 
  4762.  
  4763.  FAX_PHONEBOOKNOTSETUP 
  4764.  
  4765.  
  4766. ΓòÉΓòÉΓòÉ <hidden> SetActivity - Usage ΓòÉΓòÉΓòÉ
  4767.  
  4768. Call this method to get the activity of the recipient. 
  4769.  
  4770.  
  4771. ΓòÉΓòÉΓòÉ <hidden> SetActivity - Related methods ΓòÉΓòÉΓòÉ
  4772.  
  4773.  GetActivity 
  4774.  
  4775.  
  4776. ΓòÉΓòÉΓòÉ 5.22. SetAddress ΓòÉΓòÉΓòÉ
  4777.  
  4778.  Function Syntax 
  4779.  Parameters 
  4780.  Return Values 
  4781.  Usage 
  4782.  Related methods 
  4783.  
  4784.  
  4785. ΓòÉΓòÉΓòÉ <hidden> SetAddress - Function Syntax ΓòÉΓòÉΓòÉ
  4786.  
  4787. /***************************************
  4788. /* The SetAddress method is used to
  4789. /* set the address of the recipient.
  4790. /***************************************
  4791.  
  4792. APIRET rc ;
  4793. FaxRecipient * self ;
  4794. PSZ pszBuf ;
  4795. PULONG pulLen ;
  4796.  
  4797. rc = _SetAddress ( pszBuf ) ;
  4798.  
  4799.  
  4800. ΓòÉΓòÉΓòÉ <hidden> SetAddress - Parameters ΓòÉΓòÉΓòÉ
  4801.  
  4802.  self (FaxRecipient *) - input 
  4803.      recipient object 
  4804.  
  4805.  pszBuf (PSZ) - input 
  4806.      receives the information to set. The information is NULL terminated. 
  4807.  
  4808.  
  4809. ΓòÉΓòÉΓòÉ <hidden> SetAddress - Return Values ΓòÉΓòÉΓòÉ
  4810.  
  4811. The possible return values are the following : 
  4812.  
  4813.  FAX_PHONEBOOKOK 
  4814.  
  4815.  FAX_PHONEBOOKNOTSETUP 
  4816.  
  4817.  
  4818. ΓòÉΓòÉΓòÉ <hidden> SetAddress - Usage ΓòÉΓòÉΓòÉ
  4819.  
  4820. Call this method to get the address of the recipient. 
  4821.  
  4822.  
  4823. ΓòÉΓòÉΓòÉ <hidden> SetAddress - Related methods ΓòÉΓòÉΓòÉ
  4824.  
  4825.  GetAddress 
  4826.  
  4827.  
  4828. ΓòÉΓòÉΓòÉ 5.23. SetAreaCode ΓòÉΓòÉΓòÉ
  4829.  
  4830.  Function Syntax 
  4831.  Parameters 
  4832.  Return Values 
  4833.  Usage 
  4834.  Related methods 
  4835.  
  4836.  
  4837. ΓòÉΓòÉΓòÉ <hidden> SetAreaCode - Function Syntax ΓòÉΓòÉΓòÉ
  4838.  
  4839. /***************************************
  4840. /* The SetAreaCode method is used to
  4841. /* set the area code of the recipient.
  4842. /***************************************
  4843.  
  4844. APIRET rc ;
  4845. FaxRecipient * self ;
  4846. PSZ pszBuf ;
  4847. PULONG pulLen ;
  4848.  
  4849. rc = _SetAreaCode ( pszBuf ) ;
  4850.  
  4851.  
  4852. ΓòÉΓòÉΓòÉ <hidden> SetAreaCode - Parameters ΓòÉΓòÉΓòÉ
  4853.  
  4854.  self (FaxRecipient *) - input 
  4855.      recipient object 
  4856.  
  4857.  pszBuf (PSZ) - input 
  4858.      receives the information to set. The information is NULL terminated. 
  4859.  
  4860.  
  4861. ΓòÉΓòÉΓòÉ <hidden> SetAreaCode - Return Values ΓòÉΓòÉΓòÉ
  4862.  
  4863. The possible return values are the following : 
  4864.  
  4865.  FAX_PHONEBOOKOK 
  4866.  
  4867.  FAX_PHONEBOOKNOTSETUP 
  4868.  
  4869.  
  4870. ΓòÉΓòÉΓòÉ <hidden> SetAreaCode - Usage ΓòÉΓòÉΓòÉ
  4871.  
  4872. Call this method to get the area code of the recipient. 
  4873.  
  4874.  
  4875. ΓòÉΓòÉΓòÉ <hidden> SetAreaCode - Related methods ΓòÉΓòÉΓòÉ
  4876.  
  4877.  GetAreaCode 
  4878.  
  4879.  
  4880. ΓòÉΓòÉΓòÉ 5.24. SetCity ΓòÉΓòÉΓòÉ
  4881.  
  4882.  Function Syntax 
  4883.  Parameters 
  4884.  Return Values 
  4885.  Usage 
  4886.  Related methods 
  4887.  
  4888.  
  4889. ΓòÉΓòÉΓòÉ <hidden> SetCity - Function Syntax ΓòÉΓòÉΓòÉ
  4890.  
  4891. /***************************************
  4892. /* The SetCity method is used to
  4893. /* set the city of the recipient.
  4894. /***************************************
  4895.  
  4896. APIRET rc ;
  4897. FaxRecipient * self ;
  4898. PSZ pszBuf ;
  4899. PULONG pulLen ;
  4900.  
  4901. rc = _SetCity ( pszBuf ) ;
  4902.  
  4903.  
  4904. ΓòÉΓòÉΓòÉ <hidden> SetCity - Parameters ΓòÉΓòÉΓòÉ
  4905.  
  4906.  self (FaxRecipient *) - input 
  4907.      recipient object 
  4908.  
  4909.  pszBuf (PSZ) - input 
  4910.      receives the information to set. The information is NULL terminated. 
  4911.  
  4912.  
  4913. ΓòÉΓòÉΓòÉ <hidden> SetCity - Return Values ΓòÉΓòÉΓòÉ
  4914.  
  4915. The possible return values are the following : 
  4916.  
  4917.  FAX_PHONEBOOKOK 
  4918.  
  4919.  FAX_PHONEBOOKNOTSETUP 
  4920.  
  4921.  
  4922. ΓòÉΓòÉΓòÉ <hidden> SetCity - Usage ΓòÉΓòÉΓòÉ
  4923.  
  4924. Call this method to get the city of the recipient. 
  4925.  
  4926.  
  4927. ΓòÉΓòÉΓòÉ <hidden> SetCity - Related methods ΓòÉΓòÉΓòÉ
  4928.  
  4929.  GetCity 
  4930.  
  4931.  
  4932. ΓòÉΓòÉΓòÉ 5.25. SetCompany ΓòÉΓòÉΓòÉ
  4933.  
  4934.  Function Syntax 
  4935.  Parameters 
  4936.  Return Values 
  4937.  Usage 
  4938.  Related methods 
  4939.  
  4940.  
  4941. ΓòÉΓòÉΓòÉ <hidden> SetCompany - Function Syntax ΓòÉΓòÉΓòÉ
  4942.  
  4943. /***************************************
  4944. /* The SetCompany method is used to
  4945. /* set the company of the recipient.
  4946. /***************************************
  4947.  
  4948. APIRET rc ;
  4949. FaxRecipient * self ;
  4950. PSZ pszBuf ;
  4951. PULONG pulLen ;
  4952.  
  4953. rc = _SetCompany ( pszBuf ) ;
  4954.  
  4955.  
  4956. ΓòÉΓòÉΓòÉ <hidden> SetCompany - Parameters ΓòÉΓòÉΓòÉ
  4957.  
  4958.  self (FaxRecipient *) - input 
  4959.      recipient object 
  4960.  
  4961.  pszBuf (PSZ) - input 
  4962.      receives the information to set. The information is NULL terminated. 
  4963.  
  4964.  
  4965. ΓòÉΓòÉΓòÉ <hidden> SetCompany - Return Values ΓòÉΓòÉΓòÉ
  4966.  
  4967. The possible return values are the following : 
  4968.  
  4969.  FAX_PHONEBOOKOK 
  4970.  
  4971.  FAX_PHONEBOOKNOTSETUP 
  4972.  
  4973.  
  4974. ΓòÉΓòÉΓòÉ <hidden> SetCompany - Usage ΓòÉΓòÉΓòÉ
  4975.  
  4976. Call this method to get the company of the recipient. 
  4977.  
  4978.  
  4979. ΓòÉΓòÉΓòÉ <hidden> SetCompany - Related methods ΓòÉΓòÉΓòÉ
  4980.  
  4981.  GetCompany 
  4982.  
  4983.  
  4984. ΓòÉΓòÉΓòÉ 5.26. SetCountry ΓòÉΓòÉΓòÉ
  4985.  
  4986.  Function Syntax 
  4987.  Parameters 
  4988.  Return Values 
  4989.  Usage 
  4990.  Related methods 
  4991.  
  4992.  
  4993. ΓòÉΓòÉΓòÉ <hidden> SetCountry - Function Syntax ΓòÉΓòÉΓòÉ
  4994.  
  4995. /***************************************
  4996. /* The SetCountry method is used to
  4997. /* set the country of the recipient.
  4998. /***************************************
  4999.  
  5000. APIRET rc ;
  5001. FaxRecipient * self ;
  5002. PSZ pszBuf ;
  5003. PULONG pulLen ;
  5004.  
  5005. rc = _SetCountry ( pszBuf ) ;
  5006.  
  5007.  
  5008. ΓòÉΓòÉΓòÉ <hidden> SetCountry - Parameters ΓòÉΓòÉΓòÉ
  5009.  
  5010.  self (FaxRecipient *) - input 
  5011.      recipient object 
  5012.  
  5013.  pszBuf (PSZ) - input 
  5014.      receives the information to set. The information is NULL terminated. 
  5015.  
  5016.  
  5017. ΓòÉΓòÉΓòÉ <hidden> SetCountry - Return Values ΓòÉΓòÉΓòÉ
  5018.  
  5019. The possible return values are the following : 
  5020.  
  5021.  FAX_PHONEBOOKOK 
  5022.  
  5023.  FAX_PHONEBOOKNOTSETUP 
  5024.  
  5025.  
  5026. ΓòÉΓòÉΓòÉ <hidden> SetCountry - Usage ΓòÉΓòÉΓòÉ
  5027.  
  5028. Call this method to get the country of the recipient. 
  5029.  
  5030.  
  5031. ΓòÉΓòÉΓòÉ <hidden> SetCountry - Related methods ΓòÉΓòÉΓòÉ
  5032.  
  5033.  GetCountry 
  5034.  
  5035.  
  5036. ΓòÉΓòÉΓòÉ 5.27. SetCountryCode ΓòÉΓòÉΓòÉ
  5037.  
  5038.  Function Syntax 
  5039.  Parameters 
  5040.  Return Values 
  5041.  Usage 
  5042.  Related methods 
  5043.  
  5044.  
  5045. ΓòÉΓòÉΓòÉ <hidden> SetCountryCode - Function Syntax ΓòÉΓòÉΓòÉ
  5046.  
  5047. /***************************************
  5048. /* The SetCountryCode  method is used to
  5049. /* set the country code of the recipient
  5050. /***************************************
  5051.  
  5052. APIRET rc ;
  5053. FaxRecipient * self ;
  5054. PSZ pszBuf ;
  5055. PULONG pulLen ;
  5056.  
  5057. rc = _SetCountryCode ( pszBuf ) ;
  5058.  
  5059.  
  5060. ΓòÉΓòÉΓòÉ <hidden> SetCountryCode - Parameters ΓòÉΓòÉΓòÉ
  5061.  
  5062.  self (FaxRecipient *) - input 
  5063.      recipient object 
  5064.  
  5065.  pszBuf (PSZ) - input 
  5066.      receives the information to set. The information is NULL terminated. 
  5067.  
  5068.  
  5069. ΓòÉΓòÉΓòÉ <hidden> SetCountryCode - Return Values ΓòÉΓòÉΓòÉ
  5070.  
  5071. The possible return values are the following : 
  5072.  
  5073.  FAX_PHONEBOOKOK 
  5074.  
  5075.  FAX_PHONEBOOKNOTSETUP 
  5076.  
  5077.  
  5078. ΓòÉΓòÉΓòÉ <hidden> SetCountryCode - Usage ΓòÉΓòÉΓòÉ
  5079.  
  5080. Call this method to get the country code of the recipient. 
  5081.  
  5082.  
  5083. ΓòÉΓòÉΓòÉ <hidden> SetCountryCode - Related methods ΓòÉΓòÉΓòÉ
  5084.  
  5085.  GetCountryCode 
  5086.  
  5087.  
  5088. ΓòÉΓòÉΓòÉ 5.28. SetDivision ΓòÉΓòÉΓòÉ
  5089.  
  5090.  Function Syntax 
  5091.  Parameters 
  5092.  Return Values 
  5093.  Usage 
  5094.  Related methods 
  5095.  
  5096.  
  5097. ΓòÉΓòÉΓòÉ <hidden> SetDivision - Function Syntax ΓòÉΓòÉΓòÉ
  5098.  
  5099. /***************************************
  5100. /* The SetDivision  method is used to
  5101. /* set the division of the recipient.
  5102. /***************************************
  5103.  
  5104. APIRET rc ;
  5105. FaxRecipient * self ;
  5106. PSZ pszBuf ;
  5107. PULONG pulLen ;
  5108.  
  5109. rc = _SetDivision ( pszBuf ) ;
  5110.  
  5111.  
  5112. ΓòÉΓòÉΓòÉ <hidden> SetDivision - Parameters ΓòÉΓòÉΓòÉ
  5113.  
  5114.  self (FaxRecipient *) - input 
  5115.      recipient object 
  5116.  
  5117.  pszBuf (PSZ) - input 
  5118.      receives the information to set. The information is NULL terminated. 
  5119.  
  5120.  
  5121. ΓòÉΓòÉΓòÉ <hidden> SetDivision - Return Values ΓòÉΓòÉΓòÉ
  5122.  
  5123. The possible return values are the following : 
  5124.  
  5125.  FAX_PHONEBOOKOK 
  5126.  
  5127.  FAX_PHONEBOOKNOTSETUP 
  5128.  
  5129.  
  5130. ΓòÉΓòÉΓòÉ <hidden> SetDivision - Usage ΓòÉΓòÉΓòÉ
  5131.  
  5132. Call this method to get the division of the recipient. 
  5133.  
  5134.  
  5135. ΓòÉΓòÉΓòÉ <hidden> SetDivision - Related methods ΓòÉΓòÉΓòÉ
  5136.  
  5137.  GetDivision 
  5138.  
  5139.  
  5140. ΓòÉΓòÉΓòÉ 5.29. SetExtension ΓòÉΓòÉΓòÉ
  5141.  
  5142.  Function Syntax 
  5143.  Parameters 
  5144.  Return Values 
  5145.  Usage 
  5146.  Related methods 
  5147.  
  5148.  
  5149. ΓòÉΓòÉΓòÉ <hidden> SetExtension - Function Syntax ΓòÉΓòÉΓòÉ
  5150.  
  5151. /***************************************
  5152. /* The SetExtension method is used to
  5153. /* set the extension information
  5154. /* about the recipient.
  5155. /***************************************
  5156.  
  5157. APIRET rc ;
  5158. FaxRecipient * self ;
  5159. PSZ pszBuf ;
  5160. PULONG pulLen ;
  5161.  
  5162. rc = _SetExtension ( pszBuf ) ;
  5163.  
  5164.  
  5165. ΓòÉΓòÉΓòÉ <hidden> SetExtension - Parameters ΓòÉΓòÉΓòÉ
  5166.  
  5167.  self (FaxRecipient *) - input 
  5168.      recipient object 
  5169.  
  5170.  pszBuf (PSZ) - input 
  5171.      receives the information to set. The information is NULL terminated. 
  5172.  
  5173.  
  5174. ΓòÉΓòÉΓòÉ <hidden> SetExtension - Return Values ΓòÉΓòÉΓòÉ
  5175.  
  5176. The possible return values are the following : 
  5177.  
  5178.  FAX_PHONEBOOKOK 
  5179.  
  5180.  FAX_PHONEBOOKNOTSETUP 
  5181.  
  5182.  
  5183. ΓòÉΓòÉΓòÉ <hidden> SetExtension - Usage ΓòÉΓòÉΓòÉ
  5184.  
  5185. Call this method to get the extension of the recipient. 
  5186.  
  5187.  
  5188. ΓòÉΓòÉΓòÉ <hidden> SetExtension - Related methods ΓòÉΓòÉΓòÉ
  5189.  
  5190.  GetExtension 
  5191.  
  5192.  
  5193. ΓòÉΓòÉΓòÉ 5.30. SetExternalCall ΓòÉΓòÉΓòÉ
  5194.  
  5195.  Function Syntax 
  5196.  Parameters 
  5197.  Return Values 
  5198.  Usage 
  5199.  Related methods 
  5200.  
  5201.  
  5202. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Function Syntax ΓòÉΓòÉΓòÉ
  5203.  
  5204. /***************************************
  5205. /* The SetExternalCall method is used to
  5206. /* set the external call flag
  5207. /* about the recipient.
  5208. /***************************************
  5209.  
  5210. APIRET rc ;
  5211. FaxRecipient * self ;
  5212. PULONG pulExtCall ;
  5213.  
  5214. rc = _SetExternalCall ( ulExtCall ) ;
  5215.  
  5216.  
  5217. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Parameters ΓòÉΓòÉΓòÉ
  5218.  
  5219.  self (FaxRecipient *) - input 
  5220.      recipient object 
  5221.  
  5222.  ulExtCall (ULONG) - input 
  5223.      receives the information to set. 
  5224.  
  5225.  
  5226. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Return Values ΓòÉΓòÉΓòÉ
  5227.  
  5228. The possible return values are the following : 
  5229.  
  5230.  FAX_PHONEBOOKOK 
  5231.  
  5232.  FAX_PHONEBOOKNOTSETUP 
  5233.  
  5234.  
  5235. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Usage ΓòÉΓòÉΓòÉ
  5236.  
  5237. Call this method to get the external call flag of the recipient. 
  5238.  
  5239.  
  5240. ΓòÉΓòÉΓòÉ <hidden> SetExternalCall - Related methods ΓòÉΓòÉΓòÉ
  5241.  
  5242.  GetExternalCall 
  5243.  
  5244.  
  5245. ΓòÉΓòÉΓòÉ 5.31. SetName ΓòÉΓòÉΓòÉ
  5246.  
  5247.  Function Syntax 
  5248.  Parameters 
  5249.  Return Values 
  5250.  Usage 
  5251.  Related methods 
  5252.  
  5253.  
  5254. ΓòÉΓòÉΓòÉ <hidden> SetName - Function Syntax ΓòÉΓòÉΓòÉ
  5255.  
  5256. /***************************************
  5257. /* The SetName method is used to
  5258. /* set the name of the recipient.
  5259. /***************************************
  5260.  
  5261. APIRET rc ;
  5262. FaxRecipient * self ;
  5263. PSZ pszBuf ;
  5264. PULONG pulLen ;
  5265.  
  5266. rc = _SetName ( pszBuf ) ;
  5267.  
  5268.  
  5269. ΓòÉΓòÉΓòÉ <hidden> SetName - Parameters ΓòÉΓòÉΓòÉ
  5270.  
  5271.  self (FaxRecipient *) - input 
  5272.      recipient object 
  5273.  
  5274.  pszBuf (PSZ) - input 
  5275.      receives the information to set. The information is NULL terminated. 
  5276.  
  5277.  
  5278. ΓòÉΓòÉΓòÉ <hidden> SetName - Return Values ΓòÉΓòÉΓòÉ
  5279.  
  5280. The possible return values are the following : 
  5281.  
  5282.  FAX_PHONEBOOKOK 
  5283.  
  5284.  FAX_PHONEBOOKNOTSETUP 
  5285.  
  5286.  
  5287. ΓòÉΓòÉΓòÉ <hidden> SetName - Usage ΓòÉΓòÉΓòÉ
  5288.  
  5289. Call this method to get the name of the recipient. 
  5290.  
  5291.  
  5292. ΓòÉΓòÉΓòÉ <hidden> SetName - Related methods ΓòÉΓòÉΓòÉ
  5293.  
  5294.  GetName 
  5295.  
  5296.  
  5297. ΓòÉΓòÉΓòÉ 5.32. SetOwner ΓòÉΓòÉΓòÉ
  5298.  
  5299.  Function Syntax 
  5300.  Parameters 
  5301.  Return Values 
  5302.  Usage 
  5303.  Related methods 
  5304.  
  5305.  
  5306. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Function Syntax ΓòÉΓòÉΓòÉ
  5307.  
  5308. /***************************************
  5309. /* The SetOwner method is used to
  5310. /* set the name of the recipient entry's
  5311. /* owner.
  5312. /***************************************
  5313.  
  5314. APIRET rc ;
  5315. FaxRecipient * self ;
  5316. PSZ pszBuf ;
  5317. PULONG pulLen ;
  5318.  
  5319. rc = _SetOwner ( pszBuf ) ;
  5320.  
  5321.  
  5322. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Parameters ΓòÉΓòÉΓòÉ
  5323.  
  5324.  self (FaxRecipient *) - input 
  5325.      recipient object 
  5326.  
  5327.  pszBuf (PSZ) - input 
  5328.      receives the information to set. The information is NULL terminated. 
  5329.  
  5330.  
  5331. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Return Values ΓòÉΓòÉΓòÉ
  5332.  
  5333. The possible return values are the following : 
  5334.  
  5335.  FAX_PHONEBOOKOK 
  5336.  
  5337.  FAX_PHONEBOOKNOTSETUP 
  5338.  
  5339.  
  5340. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Usage ΓòÉΓòÉΓòÉ
  5341.  
  5342. Call this method to get the owner of the recipient. 
  5343.  
  5344.  
  5345. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Related methods ΓòÉΓòÉΓòÉ
  5346.  
  5347.  GetOwner 
  5348.  
  5349.  
  5350. ΓòÉΓòÉΓòÉ 5.33. SetState ΓòÉΓòÉΓòÉ
  5351.  
  5352.  Function Syntax 
  5353.  Parameters 
  5354.  Return Values 
  5355.  Usage 
  5356.  Related methods 
  5357.  
  5358.  
  5359. ΓòÉΓòÉΓòÉ <hidden> SetState - Function Syntax ΓòÉΓòÉΓòÉ
  5360.  
  5361. /***************************************
  5362. /* The SetState method is used to
  5363. /* set the state information
  5364. /* about the recipient.
  5365. /***************************************
  5366.  
  5367. APIRET rc ;
  5368. FaxRecipient * self ;
  5369. PSZ pszBuf ;
  5370. PULONG pulLen ;
  5371.  
  5372. rc = _SetState ( pszBuf ) ;
  5373.  
  5374.  
  5375. ΓòÉΓòÉΓòÉ <hidden> SetState - Parameters ΓòÉΓòÉΓòÉ
  5376.  
  5377.  self (FaxRecipient *) - input 
  5378.      recipient object 
  5379.  
  5380.  pszBuf (PSZ) - input 
  5381.      receives the information to set. The information is NULL terminated. 
  5382.  
  5383.  
  5384. ΓòÉΓòÉΓòÉ <hidden> SetState - Return Values ΓòÉΓòÉΓòÉ
  5385.  
  5386. The possible return values are the following : 
  5387.  
  5388.  FAX_PHONEBOOKOK 
  5389.  
  5390.  FAX_PHONEBOOKNOTSETUP 
  5391.  
  5392.  
  5393. ΓòÉΓòÉΓòÉ <hidden> SetState - Usage ΓòÉΓòÉΓòÉ
  5394.  
  5395. Call this method to get the state of the recipient. 
  5396.  
  5397.  
  5398. ΓòÉΓòÉΓòÉ <hidden> SetState - Related methods ΓòÉΓòÉΓòÉ
  5399.  
  5400.  GetState 
  5401.  
  5402.  
  5403. ΓòÉΓòÉΓòÉ 5.34. SetTel ΓòÉΓòÉΓòÉ
  5404.  
  5405.  Function Syntax 
  5406.  Parameters 
  5407.  Return Values 
  5408.  Usage 
  5409.  Related methods 
  5410.  
  5411.  
  5412. ΓòÉΓòÉΓòÉ <hidden> SetTel - Function Syntax ΓòÉΓòÉΓòÉ
  5413.  
  5414. /***************************************
  5415. /* The SetTel method is used to
  5416. /* set the fax telephone number
  5417. /* of the recipient.
  5418. /***************************************
  5419.  
  5420. APIRET rc ;
  5421. FaxRecipient * self ;
  5422. PSZ pszBuf ;
  5423. PULONG pulLen ;
  5424.  
  5425. rc = _SetTel ( pszBuf ) ;
  5426.  
  5427.  
  5428. ΓòÉΓòÉΓòÉ <hidden> SetTel - Parameters ΓòÉΓòÉΓòÉ
  5429.  
  5430.  self (FaxRecipient *) - input 
  5431.      recipient object 
  5432.  
  5433.  pszBuf (PSZ) - input 
  5434.      receives the information to set. The information is NULL terminated. 
  5435.  
  5436.  
  5437. ΓòÉΓòÉΓòÉ <hidden> SetTel - Return Values ΓòÉΓòÉΓòÉ
  5438.  
  5439. The possible return values are the following : 
  5440.  
  5441.  FAX_PHONEBOOKOK 
  5442.  
  5443.  FAX_PHONEBOOKNOTSETUP 
  5444.  
  5445.  
  5446. ΓòÉΓòÉΓòÉ <hidden> SetTel - Usage ΓòÉΓòÉΓòÉ
  5447.  
  5448. Call this method to get the fax telephone number of the recipient. 
  5449.  
  5450.  
  5451. ΓòÉΓòÉΓòÉ <hidden> SetTel - Related methods ΓòÉΓòÉΓòÉ
  5452.  
  5453.  GetTel 
  5454.  
  5455.  
  5456. ΓòÉΓòÉΓòÉ 5.35. Setup ΓòÉΓòÉΓòÉ
  5457.  
  5458.  Function Syntax 
  5459.  Parameters 
  5460.  Return Values 
  5461.  Notes 
  5462.  Usage 
  5463.  Related methods 
  5464.  
  5465.  
  5466. ΓòÉΓòÉΓòÉ <hidden> Setup - Function Syntax ΓòÉΓòÉΓòÉ
  5467.  
  5468. /***************************************
  5469. /* The Setup method is used to
  5470. /* perform initialization before using
  5471. /* a recipient object.
  5472. /***************************************
  5473.  
  5474. APIRET rc ;
  5475. FaxRecipient * self ;
  5476. PSZ pszOwner ;
  5477. PULONG pulLen ;
  5478.  
  5479. rc = _Setup ( pszOwner ) ;
  5480.  
  5481.  
  5482. ΓòÉΓòÉΓòÉ <hidden> Setup - Parameters ΓòÉΓòÉΓòÉ
  5483.  
  5484.  self (FaxRecipient *) - input 
  5485.      recipient object 
  5486.  
  5487.  pszOwner (PSZ) - input 
  5488.      identifier of the owner of the entry in the phone book. 
  5489.  
  5490.  
  5491. ΓòÉΓòÉΓòÉ <hidden> Setup - Return Values ΓòÉΓòÉΓòÉ
  5492.  
  5493. The possible return values are the following : 
  5494.  
  5495.  FAX_PHONEBOOKOK 
  5496.  
  5497.  FAX_PHONEBOOKNOTSETUP 
  5498.  
  5499.  
  5500. ΓòÉΓòÉΓòÉ <hidden> Setup - Notes ΓòÉΓòÉΓòÉ
  5501.  
  5502. Calling this method is imperative before any use of the object. If a call to a 
  5503. method is made bfore calling the Setup method, the call will return an error 
  5504. FAX_PHONEBOOKNOTSETUP. 
  5505.  
  5506. The parameter pszOwner is the name of the owner of the entry. No control is 
  5507. made in this version of the API, but later versions will use the name of the 
  5508. owner to perform control. 
  5509.  
  5510.  
  5511. ΓòÉΓòÉΓòÉ <hidden> Setup - Usage ΓòÉΓòÉΓòÉ
  5512.  
  5513. Call this method to perform the setup of the recipient before calling any other 
  5514. method. 
  5515.  
  5516.  
  5517. ΓòÉΓòÉΓòÉ <hidden> Setup - Related methods ΓòÉΓòÉΓòÉ
  5518.  
  5519. Text 
  5520.  
  5521.  
  5522. ΓòÉΓòÉΓòÉ 5.36. SetZip ΓòÉΓòÉΓòÉ
  5523.  
  5524.  Function Syntax 
  5525.  Parameters 
  5526.  Return Values 
  5527.  Usage 
  5528.  Related methods 
  5529.  
  5530.  
  5531. ΓòÉΓòÉΓòÉ <hidden> SetZip - Function Syntax ΓòÉΓòÉΓòÉ
  5532.  
  5533. /***************************************
  5534. /* The SetZip method is used to
  5535. /* set the ZIP code of the recipient.
  5536. /***************************************
  5537.  
  5538. APIRET rc ;
  5539. FaxRecipient * self ;
  5540. PSZ pszBuf ;
  5541. PULONG pulLen ;
  5542.  
  5543. rc = _SetZip ( pszBuf ) ;
  5544.  
  5545.  
  5546. ΓòÉΓòÉΓòÉ <hidden> SetZip - Parameters ΓòÉΓòÉΓòÉ
  5547.  
  5548.  self (FaxRecipient *) - input 
  5549.      recipient object 
  5550.  
  5551.  pszBuf (PSZ) - input 
  5552.      receives the information to set. The information is NULL terminated. 
  5553.  
  5554.  
  5555. ΓòÉΓòÉΓòÉ <hidden> SetZip - Return Values ΓòÉΓòÉΓòÉ
  5556.  
  5557. The possible return values are the following : 
  5558.  
  5559.  FAX_PHONEBOOKOK 
  5560.  
  5561.  FAX_PHONEBOOKNOTSETUP 
  5562.  
  5563.  
  5564. ΓòÉΓòÉΓòÉ <hidden> SetZip - Usage ΓòÉΓòÉΓòÉ
  5565.  
  5566. Call this method to get the ZIP code of the recipient. 
  5567.  
  5568.  
  5569. ΓòÉΓòÉΓòÉ <hidden> SetZip - Related methods ΓòÉΓòÉΓòÉ
  5570.  
  5571.  GetZip 
  5572.  
  5573.  
  5574. ΓòÉΓòÉΓòÉ 5.37. somInit ΓòÉΓòÉΓòÉ
  5575.  
  5576.  Function Syntax 
  5577.  Parameters 
  5578.  Notes 
  5579.  Usage 
  5580.  
  5581.  
  5582. ΓòÉΓòÉΓòÉ <hidden> somInit - Function Syntax ΓòÉΓòÉΓòÉ
  5583.  
  5584. /***************************************
  5585. /* The somInit method is overriden to
  5586. /* initialize the object.
  5587. /***************************************
  5588.  
  5589. APIRET rc ;
  5590. FaxRecipient * self ;
  5591. PSZ pszBuf ;
  5592. PULONG pulLen ;
  5593.  
  5594. _somInit ( self ) ;
  5595.  
  5596.  
  5597. ΓòÉΓòÉΓòÉ <hidden> somInit - Parameters ΓòÉΓòÉΓòÉ
  5598.  
  5599.  self (FaxRecipient *) - input 
  5600.      recipient object 
  5601.  
  5602.  
  5603. ΓòÉΓòÉΓòÉ <hidden> somInit - Notes ΓòÉΓòÉΓòÉ
  5604.  
  5605. This function sets all the recipient information to 0 for numbers and to empty 
  5606. strings for strings. If this function is explicitly called, the Setup must be 
  5607. called before any other method. 
  5608.  
  5609.  
  5610. ΓòÉΓòÉΓòÉ <hidden> somInit - Usage ΓòÉΓòÉΓòÉ
  5611.  
  5612. Call this method to reset a recipient to an empty state. This state is the same 
  5613. state as immediately after the object creation. 
  5614.  
  5615.  
  5616. ΓòÉΓòÉΓòÉ 5.38. Update ΓòÉΓòÉΓòÉ
  5617.  
  5618.  Function Syntax 
  5619.  Parameters 
  5620.  Return Values 
  5621.  Notes 
  5622.  Usage 
  5623.  Related methods 
  5624.  
  5625.  
  5626. ΓòÉΓòÉΓòÉ <hidden> Update - Function Syntax ΓòÉΓòÉΓòÉ
  5627.  
  5628. /***************************************
  5629. /* The Update method is used to update
  5630. /* the current name.
  5631. /***************************************
  5632.  
  5633. APIRET rc ;
  5634. FaxRecipient * self ;
  5635.  
  5636. rc = _Update ( self ) ;
  5637.  
  5638.  
  5639. ΓòÉΓòÉΓòÉ <hidden> Update - Parameters ΓòÉΓòÉΓòÉ
  5640.  
  5641.  self (FaxRecipient *) - input 
  5642.      recipient object 
  5643.  
  5644.  
  5645. ΓòÉΓòÉΓòÉ <hidden> Update - Return Values ΓòÉΓòÉΓòÉ
  5646.  
  5647. The possible return values are the following : 
  5648.  
  5649.  FAX_PHONEBOOKOK 
  5650.  
  5651.  FAX_PHONEBOOKNOTSETUP 
  5652.  
  5653.  FAX_PHONEBOOKERROR_UNKNOWN 
  5654.  
  5655.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  5656.  
  5657.  
  5658. ΓòÉΓòÉΓòÉ <hidden> Update - Notes ΓòÉΓòÉΓòÉ
  5659.  
  5660.  Before calling this method, there must be a current name retrieved with Get. 
  5661.  
  5662.  
  5663. ΓòÉΓòÉΓòÉ <hidden> Update - Usage ΓòÉΓòÉΓòÉ
  5664.  
  5665. Call this method to update a name in the entry. 
  5666.  
  5667.  
  5668. ΓòÉΓòÉΓòÉ <hidden> Update - Related methods ΓòÉΓòÉΓòÉ
  5669.  
  5670.  Create 
  5671.  Delete 
  5672.  Get 
  5673.  
  5674.  
  5675. ΓòÉΓòÉΓòÉ 6. Group Class ΓòÉΓòÉΓòÉ
  5676.  
  5677. The FaxGroup class allows you to build groups of entries in the phone book. 
  5678.  
  5679.  
  5680. ΓòÉΓòÉΓòÉ 6.1. AddName ΓòÉΓòÉΓòÉ
  5681.  
  5682.  Function Syntax 
  5683.  Parameters 
  5684.  Return Values 
  5685.  Notes 
  5686.  Usage 
  5687.  Related methods 
  5688.  
  5689.  
  5690. ΓòÉΓòÉΓòÉ <hidden> AddName - Function Syntax ΓòÉΓòÉΓòÉ
  5691.  
  5692. /***************************************
  5693. /* The AddName method is used to add
  5694. /* a name in a group.
  5695. /***************************************
  5696.  
  5697. APIRET rc ;
  5698. FaxGroup * self ;
  5699. PSZ pszGroup ;
  5700. PSZ pszName ;
  5701.  
  5702. rc = _AddName ( self, pszGroup, pszName ) ;
  5703.  
  5704.  
  5705. ΓòÉΓòÉΓòÉ <hidden> AddName - Parameters ΓòÉΓòÉΓòÉ
  5706.  
  5707.  self (FaxGroup *) - input 
  5708.      group object 
  5709.  
  5710.  pszGroup (PSZ) - input 
  5711.      name of the group where the name will be added. 
  5712.  
  5713.  pszName (PSZ) - input 
  5714.      name to add into the group 
  5715.  
  5716.  
  5717. ΓòÉΓòÉΓòÉ <hidden> AddName - Return Values ΓòÉΓòÉΓòÉ
  5718.  
  5719. The possible return values are the following : 
  5720.  
  5721.  FAX_PHONEBOOKOK 
  5722.  
  5723.  FAX_PHONEBOOKNOTSETUP 
  5724.  
  5725.  FAX_PHONEBOOKINVALID_PARM 
  5726.  
  5727.  FAX_PHONEBOOKERROR_UNKNOWN 
  5728.  
  5729.  
  5730. ΓòÉΓòÉΓòÉ <hidden> AddName - Notes ΓòÉΓòÉΓòÉ
  5731.  
  5732. The group and the name to add to the group must have been stored in the phone 
  5733. book before calling this method. 
  5734.  
  5735.  
  5736. ΓòÉΓòÉΓòÉ <hidden> AddName - Usage ΓòÉΓòÉΓòÉ
  5737.  
  5738. Call this method to add a name into a group. 
  5739.  
  5740.  
  5741. ΓòÉΓòÉΓòÉ <hidden> AddName - Related methods ΓòÉΓòÉΓòÉ
  5742.  
  5743.  Create 
  5744.  Create [name] 
  5745.  
  5746.  
  5747. ΓòÉΓòÉΓòÉ 6.2. Create ΓòÉΓòÉΓòÉ
  5748.  
  5749.  Function Syntax 
  5750.  Parameters 
  5751.  Return Values 
  5752.  Notes 
  5753.  Usage 
  5754.  Related methods 
  5755.  
  5756.  
  5757. ΓòÉΓòÉΓòÉ <hidden> Create - Function Syntax ΓòÉΓòÉΓòÉ
  5758.  
  5759. /***************************************
  5760. /* The Create method is used to create
  5761. /* a group in the phone book.
  5762. /***************************************
  5763.  
  5764. APIRET rc ;
  5765. FaxGroup * self ;
  5766. PSZ pszGroup ;
  5767. PSZ pszContents ;
  5768. ULONG ulLen ;
  5769.  
  5770. rc = _Create ( self, pszGroup, pszContents, ulLen ) ;
  5771.  
  5772.  
  5773. ΓòÉΓòÉΓòÉ <hidden> Create - Parameters ΓòÉΓòÉΓòÉ
  5774.  
  5775.  self (FaxGroup *) - input 
  5776.      group object 
  5777.  
  5778.  pszGroup (PSZ) - input 
  5779.      name of the group to create. 
  5780.  
  5781.  pszContents (PSZ) - input 
  5782.      list of names to add to the group. The names are separated by NULL 
  5783.      characters, and the last name is terminated by a double NULL character. If 
  5784.      this parameter is NULL, no name is added. 
  5785.  
  5786.  ulLen (ULONG) - input 
  5787.  
  5788.      size of the buffer pointed by pszContents. If pszContents is NULL, this 
  5789.      parameter must be 0. 
  5790.  
  5791.  
  5792. ΓòÉΓòÉΓòÉ <hidden> Create - Return Values ΓòÉΓòÉΓòÉ
  5793.  
  5794. The possible return values are the following : 
  5795.  
  5796.  FAX_PHONEBOOKOK 
  5797.  
  5798.  FAX_PHONEBOOKNOTSETUP 
  5799.  
  5800.  FAX_PHONEBOOKERROR_UNKNOWN 
  5801.  
  5802.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  5803.  
  5804.  
  5805. ΓòÉΓòÉΓòÉ <hidden> Create - Notes ΓòÉΓòÉΓòÉ
  5806.  
  5807. Before calling this method, the names listed in the pszContents must have been 
  5808. created in the phonebook. 
  5809.  
  5810.  
  5811. ΓòÉΓòÉΓòÉ <hidden> Create - Usage ΓòÉΓòÉΓòÉ
  5812.  
  5813. This method is used to add a group into the phonebook. 
  5814.  
  5815.  
  5816. ΓòÉΓòÉΓòÉ <hidden> Create - Related methods ΓòÉΓòÉΓòÉ
  5817.  
  5818.  Delete 
  5819.  Create [name] 
  5820.  
  5821.  
  5822. ΓòÉΓòÉΓòÉ 6.3. Delete ΓòÉΓòÉΓòÉ
  5823.  
  5824.  Function Syntax 
  5825.  Parameters 
  5826.  Return Values 
  5827.  Usage 
  5828.  Related methods 
  5829.  
  5830.  
  5831. ΓòÉΓòÉΓòÉ <hidden> Delete - Function Syntax ΓòÉΓòÉΓòÉ
  5832.  
  5833. /***************************************
  5834. /* The Delete method is used to remove
  5835. /* a group from the phonebook.
  5836. /***************************************
  5837.  
  5838. APIRET rc ;
  5839. FaxGroup * self ;
  5840. PSZ pszGroup ;
  5841.  
  5842. rc = _Delete ( self, pszGroup ) ;
  5843.  
  5844.  
  5845. ΓòÉΓòÉΓòÉ <hidden> Delete - Parameters ΓòÉΓòÉΓòÉ
  5846.  
  5847.  self (FaxGroup *) - input 
  5848.      group object 
  5849.  
  5850.  pszGroup (PSZ) - input 
  5851.      name of the group to delete. 
  5852.  
  5853.  
  5854. ΓòÉΓòÉΓòÉ <hidden> Delete - Return Values ΓòÉΓòÉΓòÉ
  5855.  
  5856. The possible return values are the following : 
  5857.  
  5858.  FAX_PHONEBOOKOK 
  5859.  
  5860.  FAX_PHONEBOOKNOTSETUP 
  5861.  
  5862.  FAX_PHONEBOOKERROR_UNKNOWN 
  5863.  
  5864.  FAX_PHONEBOOKERROR_INVALID_PARM 
  5865.  
  5866.  
  5867. ΓòÉΓòÉΓòÉ <hidden> Delete - Usage ΓòÉΓòÉΓòÉ
  5868.  
  5869. Call this method to delete a group from the phonebook. 
  5870.  
  5871.  
  5872. ΓòÉΓòÉΓòÉ <hidden> Delete - Related methods ΓòÉΓòÉΓòÉ
  5873.  
  5874.  Create 
  5875.  
  5876.  
  5877. ΓòÉΓòÉΓòÉ 6.4. DeleteName ΓòÉΓòÉΓòÉ
  5878.  
  5879.  Function Syntax 
  5880.  Parameters 
  5881.  Return Values 
  5882.  Usage 
  5883.  Related methods 
  5884.  
  5885.  
  5886. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Function Syntax ΓòÉΓòÉΓòÉ
  5887.  
  5888. /***************************************
  5889. /* The DeleteName method is used to
  5890. /* remove a name from a group.
  5891. /***************************************
  5892.  
  5893. APIRET rc ;
  5894. FaxGroup * self ;
  5895. PSZ pszGroup ;
  5896. PSZ pszName ;
  5897.  
  5898. rc = _DeleteName ( self, pszGroup, pszName ) ;
  5899.  
  5900.  
  5901. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Parameters ΓòÉΓòÉΓòÉ
  5902.  
  5903.  self (FaxGroup *) - input 
  5904.      group object 
  5905.  
  5906.  pszGroup (PSZ) - input 
  5907.      name of the group where the name will be removed from. 
  5908.  
  5909.  pszName (PSZ) - input 
  5910.      name to add into the group 
  5911.  
  5912.  
  5913. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Return Values ΓòÉΓòÉΓòÉ
  5914.  
  5915. The possible return values are the following : 
  5916.  
  5917.  FAX_PHONEBOOKOK 
  5918.  
  5919.  FAX_PHONEBOOKNOTSETUP 
  5920.  
  5921.  FAX_PHONEBOOKERROR_UNKNOWN 
  5922.  
  5923.  FAX_PHONEBOOKERROR_INVALID_PARM 
  5924.  
  5925.  
  5926. ΓòÉΓòÉΓòÉ <hidden> Create - Notes ΓòÉΓòÉΓòÉ
  5927.  
  5928. If you delete a name from the phone book, the name is automatically removed 
  5929. from all the groups it is referenced in. 
  5930.  
  5931.  
  5932. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Usage ΓòÉΓòÉΓòÉ
  5933.  
  5934. Call this method to remove a name from a group. 
  5935.  
  5936.  
  5937. ΓòÉΓòÉΓòÉ <hidden> DeleteName - Related methods ΓòÉΓòÉΓòÉ
  5938.  
  5939.  AddName 
  5940.  Delete [name] 
  5941.  
  5942.  
  5943. ΓòÉΓòÉΓòÉ 6.5. GetAllNames ΓòÉΓòÉΓòÉ
  5944.  
  5945.  Function Syntax 
  5946.  Parameters 
  5947.  Return Values 
  5948.  Usage 
  5949.  
  5950.  
  5951. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Function Syntax ΓòÉΓòÉΓòÉ
  5952.  
  5953. /***************************************
  5954. /* The GetAllNames method is used to
  5955. /* get the list of all the groups in
  5956. /* the phonebook.
  5957. /***************************************
  5958.  
  5959. APIRET rc ;
  5960. FaxGroup * self ;
  5961. PSZ pszVal ;
  5962. PULONG pulLen ;
  5963.  
  5964. rc = _GetAllNames ( self, pszVal, pulLen ) ;
  5965.  
  5966.  
  5967. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Parameters ΓòÉΓòÉΓòÉ
  5968.  
  5969.  self (FaxGroup *) - input 
  5970.      group object 
  5971.  
  5972.  pszBuffer (PSZ) - output 
  5973.      receives the list of groups. If this field is NULL, the pulLen parameter 
  5974.      receives the actual length to be returned. 
  5975.      The list is terminated by a double NULL character. All the names in the 
  5976.      list are separated by NULL characters. 
  5977.  
  5978.  pulLen (PULONG) - input/output 
  5979.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  5980.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  5981.      must contain 0. Then, on output it will receive the size of the required 
  5982.      memory. 
  5983.  
  5984.  
  5985. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Return Values ΓòÉΓòÉΓòÉ
  5986.  
  5987. The possible return values are the following : 
  5988.  
  5989.  FAX_PHONEBOOKOK 
  5990.  
  5991.  FAX_PHONEBOOKNOTSETUP 
  5992.  
  5993.  FAX_PHONEBOOKERROR_UNKNOWN 
  5994.  
  5995.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  5996.  
  5997.  
  5998. ΓòÉΓòÉΓòÉ <hidden> GetAllNames - Usage ΓòÉΓòÉΓòÉ
  5999.  
  6000. Call this method to get all the group names in the phone book. 
  6001.  
  6002.  
  6003. ΓòÉΓòÉΓòÉ 6.6. GetGroupContents ΓòÉΓòÉΓòÉ
  6004.  
  6005.  Function Syntax 
  6006.  Parameters 
  6007.  Return Values 
  6008.  Usage 
  6009.  
  6010.  
  6011. ΓòÉΓòÉΓòÉ <hidden> GetGroupContents - Function Syntax ΓòÉΓòÉΓòÉ
  6012.  
  6013. /***************************************
  6014. /* The GetGroupContents method is used to
  6015. /* get the list of all the groups in
  6016. /* the phonebook.
  6017. /***************************************
  6018.  
  6019. APIRET rc ;
  6020. FaxGroup * self ;
  6021. PSZ pszGroup ;
  6022. PSZ pszVal ;
  6023. PULONG pulLen ;
  6024.  
  6025. rc = _GetGroupContents ( self, pszGroup, pszVal, pulLen ) ;
  6026.  
  6027.  
  6028. ΓòÉΓòÉΓòÉ <hidden> GetGroupContents - Parameters ΓòÉΓòÉΓòÉ
  6029.  
  6030.  self (FaxGroup *) - input 
  6031.      group object 
  6032.  
  6033.  pszGroup (PSZ) - output 
  6034.      name of the group 
  6035.  
  6036.  pszBuffer (PSZ) - output 
  6037.      receives the list of names. If this field is NULL, the pulLen parameter 
  6038.      receives the actual length to be returned. 
  6039.      The list is terminated by a double NULL character. All the names in the 
  6040.      list are separated by NULL characters. 
  6041.  
  6042.  pulLen (PULONG) - input/output 
  6043.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  6044.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  6045.      must contain 0. Then, on output it will receive the size of the required 
  6046.      memory. 
  6047.  
  6048.  
  6049. ΓòÉΓòÉΓòÉ <hidden> GetGroupContents - Return Values ΓòÉΓòÉΓòÉ
  6050.  
  6051. The possible return values are the following : 
  6052.  
  6053.  FAX_PHONEBOOKOK 
  6054.  
  6055.  FAX_PHONEBOOKNOTSETUP 
  6056.  
  6057.  FAX_PHONEBOOKERROR_UNKNOWN 
  6058.  
  6059.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  6060.  
  6061.  
  6062. ΓòÉΓòÉΓòÉ <hidden> GetGroupContents - Usage ΓòÉΓòÉΓòÉ
  6063.  
  6064. Call this method to get all the names in a group. 
  6065.  
  6066.  
  6067. ΓòÉΓòÉΓòÉ 6.7. GetOwner ΓòÉΓòÉΓòÉ
  6068.  
  6069.  Function Syntax 
  6070.  Parameters 
  6071.  Return Values 
  6072.  Usage 
  6073.  Related methods 
  6074.  
  6075.  
  6076. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Function Syntax ΓòÉΓòÉΓòÉ
  6077.  
  6078. /***************************************
  6079. /* The GetOwner method is used to
  6080. /* get the name of the group
  6081. /* owner.
  6082. /***************************************
  6083.  
  6084. APIRET rc ;
  6085. FaxGroup * self ;
  6086. PSZ pszBuf ;
  6087. PULONG pulLen ;
  6088.  
  6089. rc = _GetOwner ( self, pszBuf, pulLen ) ;
  6090.  
  6091.  
  6092. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Parameters ΓòÉΓòÉΓòÉ
  6093.  
  6094.  self (FaxGroup *) - input 
  6095.      group object 
  6096.  
  6097.  pszBuffer (PSZ) - output 
  6098.      receives the owner. If this field is NULL, the pulLen parameter receives 
  6099.      the actual length to be returned. 
  6100.  
  6101.  pulLen (PULONG) - input/output 
  6102.      On input, contains the size of the buffer pointed by pszBuf. On output, 
  6103.      receives the length of returned data. If pszBuf is set to NULL, pulLen 
  6104.      must contain 0. Then, on output it will receive the size of the required 
  6105.      memory. 
  6106.  
  6107.  
  6108. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Return Values ΓòÉΓòÉΓòÉ
  6109.  
  6110. The possible return values are the following : 
  6111.  
  6112.  FAX_PHONEBOOKOK 
  6113.  
  6114.  FAX_PHONEBOOKNOTSETUP 
  6115.  
  6116.  
  6117. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Usage ΓòÉΓòÉΓòÉ
  6118.  
  6119. Call this method to get the name of the owner of the group. 
  6120.  
  6121.  
  6122. ΓòÉΓòÉΓòÉ <hidden> GetOwner - Related methods ΓòÉΓòÉΓòÉ
  6123.  
  6124.  SetOwner 
  6125.  
  6126.  
  6127. ΓòÉΓòÉΓòÉ 6.8. SetOwner ΓòÉΓòÉΓòÉ
  6128.  
  6129.  Function Syntax 
  6130.  Parameters 
  6131.  Return Values 
  6132.  Usage 
  6133.  Related methods 
  6134.  
  6135.  
  6136. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Function Syntax ΓòÉΓòÉΓòÉ
  6137.  
  6138. /***************************************
  6139. /* The SetOwner method is used to
  6140. /* set the name of the group
  6141. /* owner.
  6142. /***************************************
  6143.  
  6144. APIRET rc ;
  6145. FaxGroup * self ;
  6146. PSZ pszBuf ;
  6147. PULONG pulLen ;
  6148.  
  6149. rc = _SetOwner ( pszBuf ) ;
  6150.  
  6151.  
  6152. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Parameters ΓòÉΓòÉΓòÉ
  6153.  
  6154.  self (FaxGroup *) - input 
  6155.      group object 
  6156.  
  6157.  pszBuf (PSZ) - input 
  6158.      receives the information to set. The information is NULL terminated. 
  6159.  
  6160.  
  6161. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Return Values ΓòÉΓòÉΓòÉ
  6162.  
  6163. The possible return values are the following : 
  6164.  
  6165.  FAX_PHONEBOOKOK 
  6166.  
  6167.  FAX_PHONEBOOKNOTSETUP 
  6168.  
  6169.  
  6170. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Usage ΓòÉΓòÉΓòÉ
  6171.  
  6172. Call this method to get the owner of the group. 
  6173.  
  6174.  
  6175. ΓòÉΓòÉΓòÉ <hidden> SetOwner - Related methods ΓòÉΓòÉΓòÉ
  6176.  
  6177.  GetOwner 
  6178.  
  6179.  
  6180. ΓòÉΓòÉΓòÉ 6.9. Setup ΓòÉΓòÉΓòÉ
  6181.  
  6182.  Function Syntax 
  6183.  Parameters 
  6184.  Return Values 
  6185.  Notes 
  6186.  Usage 
  6187.  Related methods 
  6188.  
  6189.  
  6190. ΓòÉΓòÉΓòÉ <hidden> Setup - Function Syntax ΓòÉΓòÉΓòÉ
  6191.  
  6192. /***************************************
  6193. /* The Setup method is used to
  6194. /* perform initialization before using
  6195. /* a group object.
  6196. /***************************************
  6197.  
  6198. APIRET rc ;
  6199. FaxGroup * self ;
  6200. PSZ pszOwner ;
  6201. PULONG pulLen ;
  6202.  
  6203. rc = _Setup ( pszOwner ) ;
  6204.  
  6205.  
  6206. ΓòÉΓòÉΓòÉ <hidden> Setup - Parameters ΓòÉΓòÉΓòÉ
  6207.  
  6208.  self (FaxGroup *) - input 
  6209.      group object 
  6210.  
  6211.  pszOwner (PSZ) - input 
  6212.      identifier of the owner of the entry in the phone book. 
  6213.  
  6214.  
  6215. ΓòÉΓòÉΓòÉ <hidden> Setup - Return Values ΓòÉΓòÉΓòÉ
  6216.  
  6217. The possible return values are the following : 
  6218.  
  6219.  FAX_PHONEBOOKOK 
  6220.  
  6221.  FAX_PHONEBOOKNOTSETUP 
  6222.  
  6223.  
  6224. ΓòÉΓòÉΓòÉ <hidden> Setup - Notes ΓòÉΓòÉΓòÉ
  6225.  
  6226. Calling this method is imperative before any use of the object. If a call to a 
  6227. method is made bfore calling the Setup method, the call will return an error 
  6228. FAX_PHONEBOOKNOTSETUP. 
  6229.  
  6230. The parameter pszOwner is the name of the owner of the entry. No control is 
  6231. made in this version of the API, but later versions will use the name of the 
  6232. owner to perform control. 
  6233.  
  6234.  
  6235. ΓòÉΓòÉΓòÉ <hidden> Setup - Usage ΓòÉΓòÉΓòÉ
  6236.  
  6237. Call this method to perform the setup of the group before calling any other 
  6238. method. 
  6239.  
  6240.  
  6241. ΓòÉΓòÉΓòÉ <hidden> Setup - Related methods ΓòÉΓòÉΓòÉ
  6242.  
  6243. Text 
  6244.  
  6245.  
  6246. ΓòÉΓòÉΓòÉ 6.10. Update ΓòÉΓòÉΓòÉ
  6247.  
  6248.  Function Syntax 
  6249.  Parameters 
  6250.  Return Values 
  6251.  Notes 
  6252.  Usage 
  6253.  Related methods 
  6254.  
  6255.  
  6256. ΓòÉΓòÉΓòÉ <hidden> Update - Function Syntax ΓòÉΓòÉΓòÉ
  6257.  
  6258. /***************************************
  6259. /* The Update method is used to update
  6260. /* a group.
  6261. /***************************************
  6262.  
  6263. APIRET rc ;
  6264. FaxGroup * self ;
  6265.  
  6266. rc = _Update ( self ) ;
  6267.  
  6268.  
  6269. ΓòÉΓòÉΓòÉ <hidden> Update - Parameters ΓòÉΓòÉΓòÉ
  6270.  
  6271.  self (FaxGroup *) - input 
  6272.      group object 
  6273.  
  6274.  pszGroup (PSZ) - input 
  6275.      name of the group to update. 
  6276.  
  6277.  pszContents (PSZ) - input 
  6278.      new list of names in the group. The names are separated by NULL 
  6279.      characters, and the last name is terminated by a double NULL character. If 
  6280.      this parameter is NULL, no name is added. 
  6281.  
  6282.  ulLen (ULONG) - input 
  6283.  
  6284.      size of the buffer pointed by pszContents. If pszContents is NULL, this 
  6285.      parameter must be 0. 
  6286.  
  6287.  
  6288. ΓòÉΓòÉΓòÉ <hidden> Update - Return Values ΓòÉΓòÉΓòÉ
  6289.  
  6290. The possible return values are the following : 
  6291.  
  6292.  FAX_PHONEBOOKOK 
  6293.  
  6294.  FAX_PHONEBOOKNOTSETUP 
  6295.  
  6296.  FAX_PHONEBOOKERROR_UNKNOWN 
  6297.  
  6298.  FAX_PHONEBOOKERROR_OUTOF_MEMORY 
  6299.  
  6300.  
  6301. ΓòÉΓòÉΓòÉ <hidden> Update - Notes ΓòÉΓòÉΓòÉ
  6302.  
  6303. Before calling this method, the group must have been previously created. 
  6304.  
  6305.  
  6306. ΓòÉΓòÉΓòÉ <hidden> Update - Usage ΓòÉΓòÉΓòÉ
  6307.  
  6308. Call this method to update a group. 
  6309.  
  6310.  
  6311. ΓòÉΓòÉΓòÉ <hidden> Update - Related methods ΓòÉΓòÉΓòÉ
  6312.  
  6313.  Create 
  6314.  Delete 
  6315.  
  6316.  
  6317. ΓòÉΓòÉΓòÉ 7. Presentation Printer Driver ΓòÉΓòÉΓòÉ
  6318.  
  6319. All applications that produce printed documents, dialog with printers in the 
  6320. same way. Fax/PM printer driver acts as any other printer driver. 
  6321.  
  6322. In fact using our API througth DevPostDeviceMode does not change any source 
  6323. code inside your application. 
  6324.  
  6325. Since our Printer driver have been designed for OS/2 2.1, 32bit and 16bit 
  6326. applications act in the same way. 
  6327.  
  6328. This API is supported in ALL Fax/PM configuration. 
  6329.  
  6330. Using Fax/PM printer driver API to give your application a Send fax capability 
  6331. that does not add many extra source code in your existing application(s). Since 
  6332. we are using the standard print API, a fax capability can be added in 2 days 
  6333. job. As you will see in the sample source code, ONLY 3 source lines have been 
  6334. added to the print program and able it to send faxes. 
  6335.  
  6336.  DevPostDeviceMode syntax 
  6337.  FAX parameters 
  6338.  Example 
  6339.  
  6340.  
  6341. ΓòÉΓòÉΓòÉ 7.1. DevPostDeviceMode ΓòÉΓòÉΓòÉ
  6342.  
  6343. ULONG ulLength;
  6344. HAB hab;
  6345. PSZ pszDriverName;
  6346. PSZ pszDeviceName;
  6347. PSZ pszPrinterName;
  6348. DRIVDATA *pDrivData;
  6349. FAXDRIVERDATA *pFaxDriverData;
  6350.  
  6351.    ulLength = DevPostDeviceMode(hab,
  6352.                                 pDrivData,
  6353.                                 pszDriverName,
  6354.                                 pszDeviceName,
  6355.                                 pszPrinterName,
  6356.                                 DPDM_QUERYJOBPROP);
  6357.    pFaxDriverData = (FAXDRIVERDATA *) &pDrivData->abGeneralData[0];
  6358.  
  6359.  
  6360. ΓòÉΓòÉΓòÉ 7.2. FAX parameters ΓòÉΓòÉΓòÉ
  6361.  
  6362.   typedef struct _FAXDRIVERDATA
  6363.   {
  6364.      CHAR  szFaxName[LEN_FAXNAME];
  6365.      CHAR  szRecipient[LEN_RECIPIENT];
  6366.      CHAR  szComment[LEN_COMMENTS];
  6367.      CHAR  szLogo[LEN_LOGO];
  6368.      CHAR  szFrom[LEN_FROM];
  6369.      CHAR  szFax[LEN_MYFAXNUMBER];
  6370.      CHAR  szPhone[LEN_MYPHONENUMBER];
  6371.      CHAR  szContents[LEN_CONTENTS];
  6372.      CHAR  szStartTime[16];
  6373.      CHAR  szEndTime[16];
  6374.      ULONG ulRecipientType;
  6375.      ULONG ulHold;
  6376.      ULONG ulDialogRet;
  6377.      CHAR szTo[LEN_TO];
  6378.   } FAXDRIVERDATA;
  6379.  
  6380.  szFaxName (ASCIISZ) - input 
  6381.      Full fax file name to generated by FAXPM printer driver 
  6382.  
  6383.  szRecipient (ASCIISZ) - input 
  6384.      recipient of the Fax. It could be 
  6385.  
  6386.      o a full fax phone number including special modem's characters 
  6387.  
  6388.      o a recipient name found in  FAXPM phonebook. 
  6389.  
  6390.      o a group of recipient name found in FAXPM phonebook. 
  6391.  
  6392.  szComment (ASCIISZ) - input 
  6393.      A comment for the job created in the Workplace printer object. 
  6394.  
  6395.  szLogo (ASCIISZ) - input 
  6396.      A BITMAP file used as logo on the first page of the fax. 
  6397.  
  6398.  szFrom (ASCIISZ) - input 
  6399.      Name of the fax sender 
  6400.  
  6401.  szFax (ASCIISZ) - input 
  6402.      Fax phone number of the fax sender 
  6403.  
  6404.  szPhone (ASCIISZ) - input 
  6405.      Phone number of the fax sender 
  6406.  
  6407.  szContents (ASCIISZ) - input 
  6408.      A short description of the fax. 
  6409.  
  6410.  szStartTime (CHAR16) - input 
  6411.      The start time at which fax could be sent. Time must be specified in the 
  6412.      following format: 
  6413.  
  6414.                   YYYY-MM-DD-hh.mm
  6415.                   where:
  6416.                           YYYY = year
  6417.                           MM   = month
  6418.                           DD   = day
  6419.                           hh   = hour (0 to 23)
  6420.                           mm   = seconds
  6421.  
  6422.      szEndTime (CHAR16) - input 
  6423.      The time limit at which FAXPM must hold fax transmission. Time must be 
  6424.      specified in the following format: 
  6425.  
  6426.                   YYYY-MM-DD-hh.mm
  6427.                   where:
  6428.                           YYYY = year
  6429.                           MM   = month
  6430.                           DD   = day
  6431.                           hh   = hour (0 to 23)
  6432.                           mm   = seconds
  6433.  
  6434.  ulRecipientType (ULONG) - input 
  6435.      Flag that descibe the szRecipient contents 
  6436.  
  6437.           DESTINATION_IS_PHONE        0
  6438.           DESTINATION_IS_NAME         1
  6439.           DESTINATION_IS_LIST         2
  6440.  
  6441.  ulHold (ULONG) - input 
  6442.      Flag that creates the fax in a hold state 
  6443.  
  6444.  ulDialogRet (ULONG) - input 
  6445.      NOT USED - RESERVED for future usage 
  6446.  
  6447.  szTo (ASCIISZ) - input 
  6448.      Recipient name of the fax 
  6449.  
  6450.  
  6451. ΓòÉΓòÉΓòÉ 7.3. Example ΓòÉΓòÉΓòÉ
  6452.  
  6453. #include "faxapi.h"
  6454.  
  6455. BOOL MyFaxSend(HAB hab,
  6456.                PSZ pszQueueName,
  6457.                PSZ pszPrinterName,
  6458.                PSZ pszDriverName,
  6459.                PSZ pszDeviceName,
  6460.                PSZ pszMyFaxDocumentName,
  6461.                PSZ pszMyFaxPhoneNumber)
  6462. {
  6463.    USHORT         usRc;
  6464.    PDRIVDATA      pDrivData;
  6465.    DEVOPENSTRUC   dopData;
  6466.    HDC            hDC;
  6467.    HPS            hPS;
  6468.    ULONG          ulLength;
  6469.    FAXDRIVERDATA *pFaxDriverData;
  6470.  
  6471.    // ========================================================================
  6472.    // Ask for driver data length
  6473.    // ========================================================================
  6474.    ulLength = DevPostDeviceMode(hab,
  6475.                                 NULL,
  6476.                                 pszDriverName,
  6477.                                 pszDeviceName,
  6478.                                 pszPrinterName,
  6479.                                 DPDM_QUERYJOBPROP);
  6480.    if (ulLength == 0L) {
  6481.       return(FALSE);
  6482.    };
  6483.    // ========================================================================
  6484.    // allocate meory for driver data
  6485.    // ========================================================================
  6486.    pDrivData = (PBYTE) malloc(ulLength);
  6487.    // ========================================================================
  6488.    // call again to get driver data
  6489.    // ========================================================================
  6490.    ulLength = DevPostDeviceMode(hab,
  6491.                                 pDrivData,
  6492.                                 pszDriverName,
  6493.                                 pszDeviceName,
  6494.                                 pszPrinterName,
  6495.                                 DPDM_QUERYJOBPROP);
  6496.  
  6497.    // ================================================================
  6498.    //             Start of FAX send
  6499.    // ================================================================
  6500.    pFaxDriverData = (FAXDRIVERDATA *) &pDrivData->abGeneralData[0];
  6501.    strcpy(pFaxDriverData->szFaxName,   pszMyFaxDocumentName);
  6502.    strcpy(pFaxDriverData->szRecipient, pszMyFaxPhoneNumber);
  6503.    // ================================================================
  6504.    //             End of FAX send
  6505.    // ================================================================
  6506.  
  6507.    memset((PBYTE) &dopData, 0, sizefo(dopData));
  6508.    dopData┬╖pszLogAddress = pszQueueName;
  6509.    dopData┬╖pszDriverName = pszDriverName;
  6510.    dopData┬╖pDriv         = pDrivData;
  6511.    dopData┬╖pszDataType   = "PM_Q_RAW";
  6512.    hDC = DevOpenDC(hab,
  6513.                    OD_QUEUED,
  6514.                    "*",
  6515.                    9L,
  6516.                    (PDEVOPENDATA) &dopData,
  6517.                    NULL);
  6518.    free(pDrivData);
  6519.  
  6520.    // ========================================================================
  6521.    // Now !
  6522.    // - Create your Presentaion space
  6523.    // - Call DevEscape(┬╖┬╖┬╖ DEVESC_STARTDOC┬╖┬╖┬╖)
  6524.    // - Draw your graphics
  6525.    // - Call DevEscape(┬╖┬╖┬╖ DEVESC_ENDDOC┬╖┬╖┬╖)
  6526.    // - Destroy Presentation space
  6527.    // - DevCloseDC(hDC);
  6528.    // ========================================================================
  6529.    return(TRUE);
  6530. }
  6531.  
  6532.  
  6533. ΓòÉΓòÉΓòÉ 8. Rexx API ΓòÉΓòÉΓòÉ
  6534.  
  6535. This section describes the REXX functions that can access Fax/PM. All the 
  6536. Fax/PM REXX functions are located in the FAXREXX.DLL file. 
  6537.  
  6538.  
  6539. ΓòÉΓòÉΓòÉ 8.1. FaxLoadFuncs ΓòÉΓòÉΓòÉ
  6540.  
  6541.  Function Syntax 
  6542.  Notes 
  6543.  Usage 
  6544.  
  6545.  
  6546. ΓòÉΓòÉΓòÉ <hidden> FaxLoadFuncs - Function Syntax ΓòÉΓòÉΓòÉ
  6547.  
  6548. /***************************************
  6549. /* The FaxLoadFuncs function is used to get
  6550. /* a name in the phonebook.
  6551. /***************************************
  6552.  
  6553. RC = FaxLoadFuncs('') ;
  6554.  
  6555.  
  6556. ΓòÉΓòÉΓòÉ <hidden> FaxLoadFuncs - Usage ΓòÉΓòÉΓòÉ
  6557.  
  6558. Call this function to register all the Fax/PM REXX API functions to use them in 
  6559. the REXX routine. 
  6560.  
  6561.  
  6562. ΓòÉΓòÉΓòÉ <hidden> FaxLoadFuncs - Notes ΓòÉΓòÉΓòÉ
  6563.  
  6564. Just add the following lines to register all the functions before using them : 
  6565.  
  6566. x=RxFuncAdd('FaxLoadFuncs','faxrexx','FaxLoadFuncs')
  6567. x=FaxLoadFuncs('')
  6568.  
  6569. Note:  You can also register only the needed functions, for example : 
  6570.  
  6571. x=RxFuncAdd('RxAddName','faxrexx','RxAddName')
  6572.  
  6573.  
  6574. ΓòÉΓòÉΓòÉ 8.2. RxAddGroup ΓòÉΓòÉΓòÉ
  6575.  
  6576.  Function Syntax 
  6577.  Parameters 
  6578.  Return Values 
  6579.  Usage 
  6580.  Related methods 
  6581.  
  6582.  
  6583. ΓòÉΓòÉΓòÉ <hidden> RxAddGroup - Function Syntax ΓòÉΓòÉΓòÉ
  6584.  
  6585. /***************************************
  6586. /* The RxAddGroup function is used to add
  6587. /* a group in the phonebook.
  6588. /***************************************
  6589.  
  6590. RC = RxAddGroup(name,user) ;
  6591.  
  6592.  
  6593. ΓòÉΓòÉΓòÉ <hidden> RxAddGroup - Parameters ΓòÉΓòÉΓòÉ
  6594.  
  6595.  name 
  6596.      this is the group to add. 
  6597.  
  6598.  user 
  6599.      name of the phone book user - required but not used 
  6600.  
  6601.  
  6602. ΓòÉΓòÉΓòÉ <hidden> RxAddGroup - Return Values ΓòÉΓòÉΓòÉ
  6603.  
  6604. The possible return values are the following : 
  6605.  
  6606.  0 
  6607.  
  6608.  non 0 : Error code 
  6609.  
  6610.  
  6611. ΓòÉΓòÉΓòÉ <hidden> RxAddGroup - Usage ΓòÉΓòÉΓòÉ
  6612.  
  6613. Call this function to add a group in the phone book. 
  6614.  
  6615.  
  6616. ΓòÉΓòÉΓòÉ <hidden> RxAddGroup - Related methods ΓòÉΓòÉΓòÉ
  6617.  
  6618.  RxDelName 
  6619.  
  6620.  
  6621. ΓòÉΓòÉΓòÉ 8.3. RxAddName ΓòÉΓòÉΓòÉ
  6622.  
  6623.  Function Syntax 
  6624.  Parameters 
  6625.  Return Values 
  6626.  Notes 
  6627.  Usage 
  6628.  Related methods 
  6629.  
  6630.  
  6631. ΓòÉΓòÉΓòÉ <hidden> RxAddName - Function Syntax ΓòÉΓòÉΓòÉ
  6632.  
  6633. /***************************************
  6634. /* The RxAddName function is used to add
  6635. /* a name in the phonebook.
  6636. /***************************************
  6637.  
  6638. RC = RxAddName(name,user) ;
  6639.  
  6640.  
  6641. ΓòÉΓòÉΓòÉ <hidden> RxAddName - Parameters ΓòÉΓòÉΓòÉ
  6642.  
  6643.  name 
  6644.      this is the name information that is to be entered in the phonebook. This 
  6645.      information is a string whose format is : 
  6646.  
  6647.           "keyname_1=value_1;keyname_2=value_2;...;keyname_n=value_n"
  6648.  
  6649.      The keynames are the following : 
  6650.  
  6651.      ACTIVITY : activity of the recipient 
  6652.      AREACODE : area code of the recipient 
  6653.      CITY : city of the recipient 
  6654.      COMPANY : company of the recipient 
  6655.      COUNTRY : country of the recipient 
  6656.      COUNTRYCODE : country code of the recipient 
  6657.      DIVISION : division of the recipient 
  6658.      EXTENSION : extension of the recipient 
  6659.      EXTERNALCALL : external call flag of the recipient ("YES" or "NO") 
  6660.      NAME : name of the recipient (required) 
  6661.      STATE : state of the recipient 
  6662.      TEL : fax number of the recipient 
  6663.      ZIP : zip code of the recipient 
  6664.  
  6665.  user 
  6666.      name of the phone book user - required but not used 
  6667.  
  6668.  
  6669. ΓòÉΓòÉΓòÉ <hidden> RxAddName - Return Values ΓòÉΓòÉΓòÉ
  6670.  
  6671. The possible return values are the following : 
  6672.  
  6673.  0 
  6674.  
  6675.  non 0 : Error code 
  6676.  
  6677.  
  6678. ΓòÉΓòÉΓòÉ <hidden> RxAddName - Notes ΓòÉΓòÉΓòÉ
  6679.  
  6680. The NAME is required to add a name in the phone book. 
  6681.  
  6682. If a value contains the = sign or the ; sign, you have to use the escape 
  6683. character ^. If you need the ^ character, character use the sequence ^^. 
  6684.  
  6685. Example : if the company name to add is ABC;DEF, the setup string will contain 
  6686. : 
  6687.  
  6688. "....;COMPANY=ABC^;DEF;...."
  6689.  
  6690.  
  6691. ΓòÉΓòÉΓòÉ <hidden> RxAddName - Usage ΓòÉΓòÉΓòÉ
  6692.  
  6693. Call this function to add a name in the phone book. 
  6694.  
  6695.  
  6696. ΓòÉΓòÉΓòÉ <hidden> RxAddName - Related methods ΓòÉΓòÉΓòÉ
  6697.  
  6698.  RxDelName 
  6699.  
  6700.  
  6701. ΓòÉΓòÉΓòÉ 8.4. RxAddToGroup ΓòÉΓòÉΓòÉ
  6702.  
  6703.  Function Syntax 
  6704.  Parameters 
  6705.  Return Values 
  6706.  Notes 
  6707.  Usage 
  6708.  Related methods 
  6709.  
  6710.  
  6711. ΓòÉΓòÉΓòÉ <hidden> RxAddToGroup - Function Syntax ΓòÉΓòÉΓòÉ
  6712.  
  6713. /***************************************
  6714. /* The RxAddToGroup function is used to add
  6715. /* a name in a group.
  6716. /***************************************
  6717.  
  6718. RC = RxAddToGroup(name,group,user) ;
  6719.  
  6720.  
  6721. ΓòÉΓòÉΓòÉ <hidden> RxAddToGroup - Parameters ΓòÉΓòÉΓòÉ
  6722.  
  6723.  name 
  6724.      this is the name to add in the group. 
  6725.  
  6726.  group 
  6727.      this is the group the name will be added to. 
  6728.  
  6729.  user 
  6730.      name of the phone book user - required but not used 
  6731.  
  6732.  
  6733. ΓòÉΓòÉΓòÉ <hidden> RxAddToGroup - Return Values ΓòÉΓòÉΓòÉ
  6734.  
  6735. The possible return values are the following : 
  6736.  
  6737.  0 
  6738.  
  6739.  non 0 : Error code 
  6740.  
  6741.  
  6742. ΓòÉΓòÉΓòÉ <hidden> RxAddToGroup - Notes ΓòÉΓòÉΓòÉ
  6743.  
  6744. The name to add must have been added to the phone book before adding it to the 
  6745. group. Use the RxAddName function. 
  6746.  
  6747.  
  6748. ΓòÉΓòÉΓòÉ <hidden> RxAddToGroup - Usage ΓòÉΓòÉΓòÉ
  6749.  
  6750. Call this function to add a name in a group. 
  6751.  
  6752.  
  6753. ΓòÉΓòÉΓòÉ <hidden> RxAddToGroup - Related methods ΓòÉΓòÉΓòÉ
  6754.  
  6755.  RxDeleteFromGroup 
  6756.  
  6757.  
  6758. ΓòÉΓòÉΓòÉ 8.5. RxDeleteFromGroup ΓòÉΓòÉΓòÉ
  6759.  
  6760.  Function Syntax 
  6761.  Parameters 
  6762.  Return Values 
  6763.  Notes 
  6764.  Usage 
  6765.  Related methods 
  6766.  
  6767.  
  6768. ΓòÉΓòÉΓòÉ <hidden> RxDeleteFromGroup - Function Syntax ΓòÉΓòÉΓòÉ
  6769.  
  6770. /***************************************
  6771. /* The RxDeleteFromGroup function is
  6772. /* used to delete a name from a group.
  6773. /***************************************
  6774.  
  6775. RC = RxDeleteFromGroup(name,group,user) ;
  6776.  
  6777.  
  6778. ΓòÉΓòÉΓòÉ <hidden> RxDeleteFromGroup - Parameters ΓòÉΓòÉΓòÉ
  6779.  
  6780.  name 
  6781.      this is the name to delete from the group. 
  6782.  
  6783.  group 
  6784.      this is the group the name will be removed from. 
  6785.  
  6786.  user 
  6787.      name of the phone book user - required but not used 
  6788.  
  6789.  
  6790. ΓòÉΓòÉΓòÉ <hidden> RxDeleteFromGroup - Return Values ΓòÉΓòÉΓòÉ
  6791.  
  6792. The possible return values are the following : 
  6793.  
  6794.  0 
  6795.  
  6796.  non 0 : Error code 
  6797.  
  6798.  
  6799. ΓòÉΓòÉΓòÉ <hidden> RxDeleteFromGroup - Notes ΓòÉΓòÉΓòÉ
  6800.  
  6801. When the last name is removed from a group, this group is deleted. 
  6802.  
  6803.  
  6804. ΓòÉΓòÉΓòÉ <hidden> RxDeleteFromGroup - Usage ΓòÉΓòÉΓòÉ
  6805.  
  6806. Call this function to remove a name from a group. 
  6807.  
  6808.  
  6809. ΓòÉΓòÉΓòÉ <hidden> RxDeleteFromGroup - Related methods ΓòÉΓòÉΓòÉ
  6810.  
  6811.  RxAddToGroup 
  6812.  
  6813.  
  6814. ΓòÉΓòÉΓòÉ 8.6. RxDelGroup ΓòÉΓòÉΓòÉ
  6815.  
  6816.  Function Syntax 
  6817.  Parameters 
  6818.  Return Values 
  6819.  Usage 
  6820.  Related methods 
  6821.  
  6822.  
  6823. ΓòÉΓòÉΓòÉ <hidden> RxDelGroup - Function Syntax ΓòÉΓòÉΓòÉ
  6824.  
  6825. /***************************************
  6826. /* The RxDelGroup function is used to
  6827. /* delete a group in the phonebook.
  6828. /***************************************
  6829.  
  6830. RC = RxDelGroup(name,user) ;
  6831.  
  6832.  
  6833. ΓòÉΓòÉΓòÉ <hidden> RxDelGroup - Parameters ΓòÉΓòÉΓòÉ
  6834.  
  6835.  name 
  6836.      this is the group to remove. 
  6837.  
  6838.  user 
  6839.      name of the phone book user - required but not used 
  6840.  
  6841.  
  6842. ΓòÉΓòÉΓòÉ <hidden> RxDelGroup - Return Values ΓòÉΓòÉΓòÉ
  6843.  
  6844. The possible return values are the following : 
  6845.  
  6846.  0 
  6847.  
  6848.  non 0 : Error code 
  6849.  
  6850.  
  6851. ΓòÉΓòÉΓòÉ <hidden> RxDelGroup - Usage ΓòÉΓòÉΓòÉ
  6852.  
  6853. Call this function to delete a group in the phone book. 
  6854.  
  6855.  
  6856. ΓòÉΓòÉΓòÉ <hidden> RxDelGroup - Related methods ΓòÉΓòÉΓòÉ
  6857.  
  6858.  RxAddGroup 
  6859.  
  6860.  
  6861. ΓòÉΓòÉΓòÉ 8.7. RxDelName ΓòÉΓòÉΓòÉ
  6862.  
  6863.  Function Syntax 
  6864.  Parameters 
  6865.  Return Values 
  6866.  Usage 
  6867.  Related methods 
  6868.  
  6869.  
  6870. ΓòÉΓòÉΓòÉ <hidden> RxDelName - Function Syntax ΓòÉΓòÉΓòÉ
  6871.  
  6872. /******************************************
  6873. /* The RxDelName function is used to delete
  6874. /* a name from the phonebook.
  6875. /******************************************
  6876.  
  6877. RC = RxDelName(name,user) ;
  6878.  
  6879.  
  6880. ΓòÉΓòÉΓòÉ <hidden> RxDelName - Parameters ΓòÉΓòÉΓòÉ
  6881.  
  6882.  name 
  6883.      this is the name to delete (case-sensitive) 
  6884.  
  6885.  user 
  6886.      name of the phone book user - required but not used 
  6887.  
  6888.  
  6889. ΓòÉΓòÉΓòÉ <hidden> RxDelName - Return Values ΓòÉΓòÉΓòÉ
  6890.  
  6891. The possible return values are the following : 
  6892.  
  6893.  0 
  6894.  
  6895.  non 0 : Error code 
  6896.  
  6897.  
  6898. ΓòÉΓòÉΓòÉ <hidden> RxDelName - Usage ΓòÉΓòÉΓòÉ
  6899.  
  6900. Call this function to remove a name from the phone book. 
  6901.  
  6902.  
  6903. ΓòÉΓòÉΓòÉ <hidden> RxDelName - Related methods ΓòÉΓòÉΓòÉ
  6904.  
  6905.  RxAddName 
  6906.  
  6907.  
  6908. ΓòÉΓòÉΓòÉ 8.8. RxGetAllGroups ΓòÉΓòÉΓòÉ
  6909.  
  6910.  Function Syntax 
  6911.  Parameters 
  6912.  Notes 
  6913.  Return Values 
  6914.  Usage 
  6915.  
  6916.  
  6917. ΓòÉΓòÉΓòÉ <hidden> RxGetAllGroups - Function Syntax ΓòÉΓòÉΓòÉ
  6918.  
  6919. /***************************************
  6920. /* The RxGetAllGroups function is used to
  6921. /* get the list of all the groups.
  6922. /***************************************
  6923.  
  6924. RC = RxGetAllGroups(variable,user) ;
  6925.  
  6926.  
  6927. ΓòÉΓòÉΓòÉ <hidden> RxGetAllGroups - Parameters ΓòÉΓòÉΓòÉ
  6928.  
  6929.  variable 
  6930.      this is the name of a compound variable that will receive the list of the 
  6931.      groups. 
  6932.  
  6933.  user 
  6934.      name of the phone book user - required but not used 
  6935.  
  6936.  
  6937. ΓòÉΓòÉΓòÉ <hidden> RxGetAllGroups - Return Values ΓòÉΓòÉΓòÉ
  6938.  
  6939. The possible return values are the following : 
  6940.  
  6941.  0 
  6942.  
  6943.  non 0 : Error code 
  6944.  
  6945.  
  6946. ΓòÉΓòÉΓòÉ <hidden> RxGetAllGroups - Notes ΓòÉΓòÉΓòÉ
  6947.  
  6948. The name of the compound variable must be terminated by a dot ('.'). 
  6949.  
  6950. RxGetAllGroups ("list.","")
  6951.  
  6952. In this case, list.0 will contain the number of groups defined. The names will 
  6953. be stored in list.1, list.2 ... list.n. 
  6954.  
  6955.  
  6956. ΓòÉΓòÉΓòÉ <hidden> RxGetAllGroups - Usage ΓòÉΓòÉΓòÉ
  6957.  
  6958. Call this function to get the list of all the group names. 
  6959.  
  6960.  
  6961. ΓòÉΓòÉΓòÉ 8.9. RxGetAllNames ΓòÉΓòÉΓòÉ
  6962.  
  6963.  Function Syntax 
  6964.  Parameters 
  6965.  Return Values 
  6966.  Notes 
  6967.  Usage 
  6968.  
  6969.  
  6970. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNames - Function Syntax ΓòÉΓòÉΓòÉ
  6971.  
  6972. /***************************************
  6973. /* The RxGetAllNames function is used to
  6974. /* get the list of all the names.
  6975. /***************************************
  6976.  
  6977. RC = RxGetAllNames(variable,user) ;
  6978.  
  6979.  
  6980. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNames - Parameters ΓòÉΓòÉΓòÉ
  6981.  
  6982.  variable 
  6983.      this is the name of a compound variable that will receive the list of the 
  6984.      names. 
  6985.  
  6986.  user 
  6987.      name of the phone book user - required but not used 
  6988.  
  6989.  
  6990. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNames - Return Values ΓòÉΓòÉΓòÉ
  6991.  
  6992. The possible return values are the following : 
  6993.  
  6994.  0 
  6995.  
  6996.  non 0 : Error code 
  6997.  
  6998.  
  6999. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNames - Notes ΓòÉΓòÉΓòÉ
  7000.  
  7001. The name of the compound variable must be terminated by a dot ('.'). 
  7002.  
  7003. RxGetAllNames ("list.","")
  7004.  
  7005. In this case, list.0 will contain the number of names defined. The names will 
  7006. be stored in list.1, list.2 ... list.n. 
  7007.  
  7008.  
  7009. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNames - Usage ΓòÉΓòÉΓòÉ
  7010.  
  7011. Call this function to get the list of all the names. 
  7012.  
  7013.  
  7014. ΓòÉΓòÉΓòÉ 8.10. RxGetAllNamesInGroup ΓòÉΓòÉΓòÉ
  7015.  
  7016.  Function Syntax 
  7017.  Parameters 
  7018.  Return Values 
  7019.  Notes 
  7020.  Usage 
  7021.  
  7022.  
  7023. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNamesInGroup - Function Syntax ΓòÉΓòÉΓòÉ
  7024.  
  7025. /***************************************
  7026. /* The RxGetAllNamesInGroup function is used to
  7027. /* get the list of all the names.
  7028. /***************************************
  7029.  
  7030. RC = RxGetAllNamesInGroup(variable,group,user) ;
  7031.  
  7032.  
  7033. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNamesInGroup - Parameters ΓòÉΓòÉΓòÉ
  7034.  
  7035.  variable 
  7036.      this is the name of a compound variable that will receive the list of the 
  7037.      names. 
  7038.  
  7039.  group 
  7040.      this is the name of the group to list. names. 
  7041.  
  7042.  user 
  7043.      name of the phone book user - required but not used 
  7044.  
  7045.  
  7046. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNamesInGroup - Return Values ΓòÉΓòÉΓòÉ
  7047.  
  7048. The possible return values are the following : 
  7049.  
  7050.  0 
  7051.  
  7052.  non 0 : Error code 
  7053.  
  7054.  
  7055. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNamesInGroup - Notes ΓòÉΓòÉΓòÉ
  7056.  
  7057. The name of the compound variable must be terminated by a dot ('.'). 
  7058.  
  7059. RxGetAllNamesInGroup ("list.","")
  7060.  
  7061. In this case, list.0 will contain the number of names defined in the group. The 
  7062. names will be stored in list.1, list.2 ... list.n. 
  7063.  
  7064.  
  7065. ΓòÉΓòÉΓòÉ <hidden> RxGetAllNamesInGroup - Usage ΓòÉΓòÉΓòÉ
  7066.  
  7067. Call this function to get the list of all the names. 
  7068.  
  7069.  
  7070. ΓòÉΓòÉΓòÉ 8.11. RxGetName ΓòÉΓòÉΓòÉ
  7071.  
  7072.  Function Syntax 
  7073.  Parameters 
  7074.  Return Values 
  7075.  Usage 
  7076.  Related methods 
  7077.  
  7078.  
  7079. ΓòÉΓòÉΓòÉ <hidden> RxGetName - Function Syntax ΓòÉΓòÉΓòÉ
  7080.  
  7081. /***************************************
  7082. /* The RxGetName function is used to get
  7083. /* a name in the phonebook.
  7084. /***************************************
  7085.  
  7086. RC = RxGetName(name,user) ;
  7087.  
  7088.  
  7089. ΓòÉΓòÉΓòÉ <hidden> RxGetName - Parameters ΓòÉΓòÉΓòÉ
  7090.  
  7091.  name 
  7092.      this is the name to get from the phonebook. 
  7093.  
  7094.  user 
  7095.      name of the phone book user - required but not used 
  7096.  
  7097.  
  7098. ΓòÉΓòÉΓòÉ <hidden> RxGetName - Return Values ΓòÉΓòÉΓòÉ
  7099.  
  7100. The possible return values are the following : 
  7101.  
  7102.  information about the name. This is the same format as the 1st parameter in 
  7103.  the RxAddName. 
  7104.  
  7105.  number : Error code 
  7106.  
  7107.  
  7108. ΓòÉΓòÉΓòÉ <hidden> RxGetName - Usage ΓòÉΓòÉΓòÉ
  7109.  
  7110. Call this function to get a name from the phone book. 
  7111.  
  7112.  
  7113. ΓòÉΓòÉΓòÉ <hidden> RxGetName - Related methods ΓòÉΓòÉΓòÉ
  7114.  
  7115.  RxAddName 
  7116.  
  7117.  
  7118. ΓòÉΓòÉΓòÉ 8.12. RxSendAsciiFax ΓòÉΓòÉΓòÉ
  7119.  
  7120.  Function Syntax 
  7121.  Parameters 
  7122.  Return Values 
  7123.  Notes 
  7124.  Usage 
  7125.  
  7126.  
  7127. ΓòÉΓòÉΓòÉ <hidden> RxSendAsciiFax - Function Syntax ΓòÉΓòÉΓòÉ
  7128.  
  7129. /***************************************
  7130. /* The RxSendAsciiFax function is used to
  7131. /* send a fax with Fax/PM.
  7132. /***************************************
  7133.  
  7134. RC = RxSendAsciiFax(command,user) ;
  7135.  
  7136.  
  7137. ΓòÉΓòÉΓòÉ <hidden> RxSendAsciiFax - Parameters ΓòÉΓòÉΓòÉ
  7138.  
  7139.  command 
  7140.      this is a list of pairs keyname=value, that gives the information about 
  7141.      the fax you want to send. The format of the string is the following : 
  7142.  
  7143.           "keyname_1=value_1;keyname_2=value_2;...;keyname_n=value_n"
  7144.  
  7145.      The keynames are the following : 
  7146.  
  7147.      FILE : name of the file to send (required). This must be an ASCII file 
  7148.      OUTFILE : name of the file to send (required). Name of the generated Fax 
  7149.      file. If this file exists, it is overwritten. 
  7150.      BITMAP : name of an OS/2 bitmap file to be included at the top of the fax. 
  7151.      FONT : number indicating the size of the font. If not specified, the 
  7152.      default font is 10. 
  7153.      BOLD : indicates if the characters are displayed in boldface. The 
  7154.      authorized values are YES and NO. The default value is no boldface. 
  7155.      FAXNUM : fax phone number (required). This number must include the dialing 
  7156.      prefixes if the EXTERNAL information is not provided. 
  7157.      EXTERNAL : indicates if the call is external. The dialing prefix will be 
  7158.      added to the dialing number. The authorized values are YES and NO. 
  7159.      HEADER : indicates if a header must be included. Authorized values are YES 
  7160.      and NO. If NO is specified, or if this key is not found in the string, the 
  7161.      following keys are ignored. 
  7162.      HEADERLOGO : name of the logo. This must be a valid bitmap file name. The 
  7163.      full path must be specified. 
  7164.      HEADERFROM : name of the sender. 
  7165.      HEADERFROMFAX : fax number of the sender. 
  7166.      HEADERFROMPHONE : phone number of the sender. 
  7167.      HEADERCOMMENT : comment. Carriage return may be indicated as "\n" 
  7168.      characters. 
  7169.      HEADERTO : name of the recipient. 
  7170.  
  7171.  user 
  7172.      name of Fax/PM user - required but not used 
  7173.  
  7174.  
  7175. ΓòÉΓòÉΓòÉ <hidden> RxSendAsciiFax - Return Values ΓòÉΓòÉΓòÉ
  7176.  
  7177. The possible return values are the following : 
  7178.  
  7179.  0 : the function has failed 
  7180.  
  7181.  other : the ID of the request that you have submitted. 
  7182.  
  7183.  
  7184. ΓòÉΓòÉΓòÉ <hidden> RxSendAsciiFax - Notes ΓòÉΓòÉΓòÉ
  7185.  
  7186. If a value contains the = sign or the ; sign, you have to use the escape 
  7187. character ^. If you need the ^ character, character use the sequence ^^. 
  7188.  
  7189.  
  7190. ΓòÉΓòÉΓòÉ <hidden> RxSendAsciiFax - Usage ΓòÉΓòÉΓòÉ
  7191.  
  7192. Call this function to send an ASCII file. If a bitmap is specified, it is 
  7193. included at the top of the fax. You can also specify a header file. 
  7194.  
  7195.  
  7196. ΓòÉΓòÉΓòÉ 8.13. RxSendFax ΓòÉΓòÉΓòÉ
  7197.  
  7198.  Function Syntax 
  7199.  Parameters 
  7200.  Return Values 
  7201.  Notes 
  7202.  Usage 
  7203.  
  7204.  
  7205. ΓòÉΓòÉΓòÉ <hidden> RxSendFax - Function Syntax ΓòÉΓòÉΓòÉ
  7206.  
  7207. /***************************************
  7208. /* The RxSendFax function is used to
  7209. /* send a fax with Fax/PM.
  7210. /***************************************
  7211.  
  7212. RC = RxSendFax(command,user) ;
  7213.  
  7214.  
  7215. ΓòÉΓòÉΓòÉ <hidden> RxSendFax - Parameters ΓòÉΓòÉΓòÉ
  7216.  
  7217.  command 
  7218.      this is a list of pairs keyname=value, that gives the information about 
  7219.      the fax you want to send. The format of the string is the following : 
  7220.  
  7221.           "keyname_1=value_1;keyname_2=value_2;...;keyname_n=value_n"
  7222.  
  7223.      The keynames are the following : 
  7224.  
  7225.      FILE : name of the file to send (required) 
  7226.      FAXNUM : fax phone number (required). This number must include the dialing 
  7227.      prefixes if the EXTERNAL information is not provided. 
  7228.      FORMAT : the format of the file to send. Acceptable values are Fax and 
  7229.      Ascii (case sensitive) 
  7230.      EXTERNAL : indicates if the call is external. The dialing prefix will be 
  7231.      added to the dialing number. 
  7232.      HEADER : indicates if a header must be included. Authorized values are YES 
  7233.      and NO. If NO is specified, or if this key is not found in the string, the 
  7234.      following keys are ignored. 
  7235.      HEADERLOGO : name of the logo. This must be a valid bitmap file name. The 
  7236.      full path must be specified. 
  7237.      HEADERFROM : name of the sender. 
  7238.      HEADERFROMFAX : fax number of the sender. 
  7239.      HEADERFROMPHONE : phone number of the sender. 
  7240.      HEADERCOMMENT : comment. Carriage return may be indicated as "\n" 
  7241.      characters. 
  7242.      HEADERTO : name of the recipient. 
  7243.  
  7244.  user 
  7245.      name of Fax/PM user - required but not used 
  7246.  
  7247.  
  7248. ΓòÉΓòÉΓòÉ <hidden> RxSendFax - Return Values ΓòÉΓòÉΓòÉ
  7249.  
  7250. The possible return values are the following : 
  7251.  
  7252.  0 : the function has failed 
  7253.  
  7254.  other : the ID of the request that you have submitted. 
  7255.  
  7256.  
  7257. ΓòÉΓòÉΓòÉ <hidden> RxSendFax - Notes ΓòÉΓòÉΓòÉ
  7258.  
  7259. If a value contains the = sign or the ; sign, you have to use the escape 
  7260. character ^. If you need the ^ character, character use the sequence ^^. 
  7261.  
  7262.  
  7263. ΓòÉΓòÉΓòÉ <hidden> RxSendFax - Usage ΓòÉΓòÉΓòÉ
  7264.  
  7265. Call this function to send a fax with Fax/PM. 
  7266.  
  7267.  
  7268. ΓòÉΓòÉΓòÉ 8.14. RxUpdateName ΓòÉΓòÉΓòÉ
  7269.  
  7270.  Function Syntax 
  7271.  Parameters 
  7272.  Return Values 
  7273.  Notes 
  7274.  Usage 
  7275.  Related methods 
  7276.  
  7277.  
  7278. ΓòÉΓòÉΓòÉ <hidden> RxUpdateName - Function Syntax ΓòÉΓòÉΓòÉ
  7279.  
  7280. /***************************************
  7281. /* The RxUpdateName function is used to
  7282. /* update a name in the phonebook.
  7283. /***************************************
  7284.  
  7285. RC = RxUpdateName(name,user) ;
  7286.  
  7287.  
  7288. ΓòÉΓòÉΓòÉ <hidden> RxUpdateName - Parameters ΓòÉΓòÉΓòÉ
  7289.  
  7290.  name 
  7291.      this is the name information that is to be updated in the phonebook. This 
  7292.      information is a string whose format is : 
  7293.  
  7294.           "keyname_1=value_1;keyname_2=value_2;...;keyname_n=value_n"
  7295.  
  7296.      The keynames are the following : 
  7297.  
  7298.      ACTIVITY : activity of the recipient 
  7299.      AREACODE : area code of the recipient 
  7300.      CITY : city of the recipient 
  7301.      COMPANY : company of the recipient 
  7302.      COUNTRY : country of the recipient 
  7303.      COUNTRYCODE : country code of the recipient 
  7304.      DIVISION : division of the recipient 
  7305.      EXTENSION : extension of the recipient 
  7306.      EXTERNALCALL : external call flag of the recipient ("YES" or "NO") 
  7307.      NAME : name of the recipient (required) 
  7308.      STATE : state of the recipient 
  7309.      TEL : fax number of the recipient 
  7310.      ZIP : zip code of the recipient 
  7311.  
  7312.  user 
  7313.      name of the phone book user - required but not used 
  7314.  
  7315.  
  7316. ΓòÉΓòÉΓòÉ <hidden> RxUpdateName - Return Values ΓòÉΓòÉΓòÉ
  7317.  
  7318. The possible return values are the following : 
  7319.  
  7320.  0 
  7321.  
  7322.  non 0 : Error code 
  7323.  
  7324.  
  7325. ΓòÉΓòÉΓòÉ <hidden> RxUpdateName - Notes ΓòÉΓòÉΓòÉ
  7326.  
  7327. The NAME is required to add a name in the phone book. 
  7328.  
  7329. The fields that are not referenced in the name parameter are not updated. 
  7330.  
  7331.  
  7332. ΓòÉΓòÉΓòÉ <hidden> RxUpdateName - Usage ΓòÉΓòÉΓòÉ
  7333.  
  7334. Call this function to update a name in the phone book. 
  7335.  
  7336.  
  7337. ΓòÉΓòÉΓòÉ <hidden> RxUpdateName - Related methods ΓòÉΓòÉΓòÉ
  7338.  
  7339.  RxAddName 
  7340.  RxDelName 
  7341.  RxGetName 
  7342.  
  7343.  
  7344. ΓòÉΓòÉΓòÉ 9. External routine on receive ΓòÉΓòÉΓòÉ
  7345.  
  7346. Fax/PM allows you to call an external routine when a fax has been received. 
  7347.  
  7348.  
  7349. ΓòÉΓòÉΓòÉ 9.1. Description ΓòÉΓòÉΓòÉ
  7350.  
  7351. Fax/PM allows you to call an external routine when a fax has been received. 
  7352. When a fax has been received, Fax/PM looks for a DLL called FAXEXIT2.DLL, and 
  7353. try to call a function called FAXRECEIVED. 
  7354.  
  7355. The steps to perform to define your own external routine are the following : 
  7356.  
  7357.   1. Create a DLL called FAXEXIT2 that contains a FAXRECEIVED function. The 
  7358.      FAXRECEIVED function must be exported. 
  7359.   2. Copy this DLL in a directory that is referenced in the LIBPATH statement 
  7360.      of the CONFIG.SYS file. 
  7361.  
  7362.  
  7363. ΓòÉΓòÉΓòÉ 9.2. RECEIVEDFAX ΓòÉΓòÉΓòÉ
  7364.  
  7365.  Function Syntax 
  7366.  Parameters 
  7367.  Return Values 
  7368.  Notes 
  7369.  Usage 
  7370.  
  7371.  
  7372. ΓòÉΓòÉΓòÉ <hidden> RECEIVEDFAX - Function Syntax ΓòÉΓòÉΓòÉ
  7373.  
  7374. /***************************************
  7375. /* The RECEIVEDFAX function is called
  7376. /* when a fax has been received.
  7377. /***************************************
  7378.  
  7379. APIRET APIENTRY RECEIVEDFAX ( PSZ pszFile, PSZ pszId, ULONG ulChannel ) ;
  7380.  
  7381.  
  7382. ΓòÉΓòÉΓòÉ <hidden> RECEIVEDFAX - Parameters ΓòÉΓòÉΓòÉ
  7383.  
  7384.  pszFile (PSZ) - input 
  7385.      this is the full path name of the received fax. 
  7386.  
  7387.  pszId (PSZ) - input 
  7388.      this is the identifier of the remote fax machine that has sent the Fax. 
  7389.  
  7390.  ulChannel (PSZ) - input 
  7391.      this is the channel number. In this version, it is always 1. 
  7392.  
  7393.  
  7394. ΓòÉΓòÉΓòÉ <hidden> RECEIVEDFAX - Return Values ΓòÉΓòÉΓòÉ
  7395.  
  7396. The return value is a unsigned long integer. Fax/PM does not interpret the 
  7397. return code. Any value is accepted. 
  7398.  
  7399.  
  7400. ΓòÉΓòÉΓòÉ <hidden> RECEIVEDFAX - Notes ΓòÉΓòÉΓòÉ
  7401.  
  7402. The function must be declared with _System linkage. (APIENTRY). 
  7403.  
  7404.  
  7405. ΓòÉΓòÉΓòÉ <hidden> RECEIVEDFAX - Usage ΓòÉΓòÉΓòÉ
  7406.  
  7407. This function is called when a fax has been successfully received. This 
  7408. function allows you to customize the action taken when a fax has been received. 
  7409. For instance, you can run an archive program, an OCR program, or perform any 
  7410. other processing. 
  7411.  
  7412.  
  7413. ΓòÉΓòÉΓòÉ 9.3. Sample ΓòÉΓòÉΓòÉ
  7414.  
  7415. In the FAXAPI subdirectory, you will find the following files : 
  7416.  
  7417.  faxexit2.c : this is the C source of the sample. 
  7418.  faxexit2.mak : this is the makefile of the sample. 
  7419.  faxexit2.def : this is the module definition file. 
  7420.  faxexit2.dll : this is the sample DLL. 
  7421.  
  7422.  This sample runs the Fax/PM Viewer that displays the received fax. 
  7423.  
  7424.  Note:  The MAKEFILE assumes that all the environment variables that are 
  7425.  necessary for compile and link (INCLUDE, PATH, LIB...) have been correctly 
  7426.  set.