GpiQuerySegmentTransformMatrix

This function returns the elements of the transform of the identified segment (see GpiSetSegmentTransformMatrix).

Syntax

GpiQuerySegmentTransformMatrix(hps, lSegid, lCount, pmatlfArray)

Parameters

hps (HPS) - input

Presentation-space handle.

lSegid (LONG) - input

Segment identifier.

lCount (LONG) - input

Number of elements.

The number of elements that are to be set in the pmatlfArray parameter. lCount must be in the range 0 through 9.

pmatlfArray (PMATRIXLF) - output

Transform matrix.

Return Value

rc (BOOL) - returns

Success indicator.

TRUE

Successful completion

FALSE

Error occurred.

Errors

Possible returns from WinGetLastError:

PMERR_INV_HPS (0x207F)

An invalid presentation-space handle was specified.

PMERR_PS_BUSY (0x20F4)

An attempt was made to access the presentation space from more than one thread simultaneously.

PMERR_INV_SEG_NAME (0x20C8)

An invalid segment identifier was specified.

PMERR_INV_MICROPS_FUNCTION (0x20A1)

An attempt was made to issue a function that is invalid in a micro presentation space.

PMERR_INV_LENGTH_OR_COUNT (0x2092)

An invalid length or count parameter was specified.

PMERR_SEG_NOT_FOUND (0x2100)

The specified segment identifier did not exist.

Example Code

#define INCL_GPITRANSFORMS /* Or use INCL_GPI, INCL_PM, */
#include <os2.h>

HPS          hps;          /*  Presentation-space handle. */
LONG         lSegid;       /*  Segment identifier. */
LONG         lCount;       /*  Number of elements. */
PMATRIXLF    pmatlfArray;  /*  Transform matrix. */
BOOL         rc;           /*  Success indicator. */

rc = GpiQuerySegmentTransformMatrix(hps, lSegid,
       lCount, pmatlfArray);

This function returns the elements of the transform of the identified segment (see GpiSetSegmentTransformMatrix).

#define INCL_GPITRANSFORMS   /* Or use INCL_GPI or INCL_PM */
#include<OS2.H>
#define COUNT 9

HPS hps;         /*   Presentation-space */
                 /*   handle.            */
LONG lSegid;     /*   Segment identifier. */
LONG lCount;     /* The number of elements     */
                 /* that are to be set in the  */
                 /* pmatlfArray parameter.     */
                 /* lCount must be in the      */
                 /* range 0 through 9.         */
MATRIXLF pmatlfArray[COUNT];   /* array of Transform matrix  */
                               /* structures. This is an     */
                               /* output parameter.          */
BOOL fSuccess;                 /* returns true if successful. */


fSuccess = GpiQuerySegmentTransformMatrix(hps,
                                          lSegid,
                                          lCount,
                                          pmatlfArray);