Jump to content

VioAssociate: Difference between revisions

From EDM2
Created page with "==Description== Associates or disassociates a VIO presentation space with a device context. ==Syntax== <PRE> #define INCL_VIO #include <os2.h> HDC hdc; /* Device-co..."
 
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
==Description==
Associates or disassociates a VIO presentation space with a device context.
Associates or disassociates a VIO presentation space with a device context.


Line 15: Line 14:


==Parameters==
==Parameters==
; hdc (HDC) - input : Device-context handle.
;hdc (HDC) - input : Device-context handle.
If this is NULL, a disassociation occurs.  
:If this is NULL, a disassociation occurs.
 
;hvps (HVIO) - input : VIO presentation space handle.
; hvps (HVIO) - input : VIO presentation space handle.
:This is returned from VioCreatePS.
This is returned from VioCreatePS.  


==Return Code==
==Return Code==
  rc (APIRET) - returns
  rc (APIRET) - returns
VioAssociate returns one of the following values:
VioAssociate returns one of the following values:
 
* 0 NO_ERROR
* 0         NO_ERROR  
* 421 ERROR_VIO_INVALID_PARMS
* 421       ERROR_VIO_INVALID_PARMS  
* 436 ERROR_VIO_INVALID_HANDLE
* 436       ERROR_VIO_INVALID_HANDLE  
* 495 ERROR_VIO_NOT_PRES_MGR_SG
* 495       ERROR_VIO_NOT_PRES_MGR_SG  
* 499 ERROR_VIO_ASSOCIATED_DC
* 499       ERROR_VIO_ASSOCIATED_DC


==Remarks==
==Remarks==
Line 39: Line 35:
An associated presentation space or device context cannot be associated.
An associated presentation space or device context cannot be associated.


The screen device context is the only kind of device that can be associated with a VIO presentation space.  
The screen device context is the only kind of device that can be associated with a VIO presentation space.
==Example Code==
<PRE>
 
</PRE>
 
==Related Functions==


[[Category:The OS/2 API Project]]
[[Category:Vio]]

Revision as of 02:41, 21 December 2016

Associates or disassociates a VIO presentation space with a device context.

Syntax

#define INCL_VIO
#include <os2.h>

HDC       hdc;   /*  Device-context handle. */
HVIO      hvps;  /*  VIO presentation space handle. */
APIRET    rc;    /*  Return code. */

rc = VioAssociate(hdc, hvps);

Parameters

hdc (HDC) - input
Device-context handle.
If this is NULL, a disassociation occurs.
hvps (HVIO) - input
VIO presentation space handle.
This is returned from VioCreatePS.

Return Code

rc (APIRET) - returns

VioAssociate returns one of the following values:

  • 0 NO_ERROR
  • 421 ERROR_VIO_INVALID_PARMS
  • 436 ERROR_VIO_INVALID_HANDLE
  • 495 ERROR_VIO_NOT_PRES_MGR_SG
  • 499 ERROR_VIO_ASSOCIATED_DC

Remarks

Subsequent VIO calls to this VIO presentation space will direct output to the specified device context.

If a null handle is specified for the device context, the presentation space is disassociated from any device context.

An associated presentation space or device context cannot be associated.

The screen device context is the only kind of device that can be associated with a VIO presentation space.