PpGetPC()

Extract data from a print context

Synopsis:

void * PpGetPC( PpPrintContext_t *pc,
                     int member,
                     const void ** const data);

Arguments:

pc

The pointer to a PpPrintContext_t structure that was returned by PpCreatePC().

data

the address of a pointer to the data type of the member being queried. This pointer will be set to point to the member within the print context structure. Don't use it to modify the print context; use only PpSetPC().

member

The member of the print context to query, as given in the table below. For a description of the members, see PpPrintContext_t.

Library:

ph

Description:

Use this function to query the attributes of a print context.

---

Don't extract values directly from the data structure. Your application might not work if the structure changes in the future.

---

Use the following data types when getting the value of the members of the print context:

Returns:

A pointer to the requested data, or NULL if an unrecognized member was specified.

Examples:

int get_it( PtWidget_t *widget, ApInfo_t *apinfo,
            PtCallbackInfo_t *cbinfo )

{

    PhDim_t *dim;
    void    *pc_data;
    PpPrintContext_t *pc;

    /* Eliminate 'unreferenced' warnings */
    widget = widget, apinfo = apinfo, cbinfo = cbinfo;

    pc = PpCreatePC();

    // Pop up the standard print dialog to fill in the PC
    PtPrintSelection( NULL, NULL,
                      "Select Printer", pc, 0 );

    // Get some stuff from the pc

    // A string:
    PpGetPC( pc, Pp_PC_NAME, &pc_data );
    printf( "printer: %s\n", (char *)pc_data );

    // A structure ( PhDim_t ):
    PpGetPC( pc, Pp_PC_PAPER_SIZE, &pc_data );
    printf( "paper height: %d, width: %d\n",
        ((PhDim_t *)pc_data)->h, ((PhDim_t *)pc_data)->w );

    // A long value:
    PpGetPC( pc, Pp_PC_INTENSITY, &pc_data );
    printf( "intensity: %ld\n", *(long *)pc_data );

    // A number stored in a char:
    PpGetPC( pc, Pp_PC_COPIES, &pc_data );
    printf( "copies : %d\n", *(char *)pc_data );

    // Of course, the correct type can be used to
    // get the member:
    PpGetPC( pc, Pp_PC_PAPER_SIZE, &dim );
    printf( "paper height: %d, width: %d\n", dim->h, dim->w );

    PpReleasePC( pc );

    return Pt_CONTINUE;
}

Classification:

Photon

See also:

PhDim_t, PhPoint_t, PhRect_t, PpContinueJob(), PpCreatePC(), PpEndJob(), PpGetCanvas(), PpLoadDefaultPrinter(), PpLoadPrinter(), PpPrintContext_t, PpPrintNewPage(), PpReleasePC(), PpPrintWidget(), PpSetCanvas(), PpSetPC(), PpSuspendJob()

Printing in the Photon Programmer's Guide