ERRORS

An error indicates that overall status is OK, but that the DCI Client's request has been refused. The exact implication is based on context, but in general a refusal implies that the same action at a later time or the same action with different parameters could be accepted.

Like failures, errors are represented by negative values and cannot be combined. If more than one error can apply to a given situation the DCI Provider may choose from the applicable errors at its discretion. This table lists the errors than can be returned by a DCI Provider.

ERRORS	MEANING	USED BY
DCI_ERR_CURRENTLYNOTAVAIL	Support is currently not available	DCI Commands and all callbacks
DCI_ERR_INVALIDRECT	Rectangle provided was invalid	DCIEnumSurface command and callbacks
DCI_ERR_UNSUPPORTEDFORMAT	FOURCC format requested by DCI Client is unsupported by DCI Provider	DCICreateOffScreen command
DCI_ERR_UNSUPPORTEDMASK	Bitmask of format requested is unsupported by DCI Provider	DCICreateOffscreen command
DCI_ERR_TOOBIGHEIGHT	Height requested by DCI Client is too large	DCICreateOffscreen command
DCI_ERR_TOOBIGWIDTH	Width requested by DCI Client is too large	DCICreateOffscreen command
DCI_ERR_TOOBIGSIZE	Size requested by DCI Client is too large -- The individual height and width are OK	DCICreateOffscreen command
DCI_ERR_OUTOFMEMORY	DCI Provider does not have enough memory to support DCI Client's request	DCICreateOffscreen and DCICreateOverlay commands
DCI_ERR_INVALIDPOSITION	DCI Provider does not support position requested	DCIEnumSurface command and callbacks
DCI_ERR_INVALIDSTRETCH	DCI Provider does not support stretch requested	DCIEnumSurface command and SetDestination callback
DCI_ERR_INVALIDCLIPLIST	DCI Provider does not support provided Cliplist	SetCliplist callback
DCI_ERR_SURFACEISOBSCURED1	Access to surface refused because surface is obscured	BeginAccess callback
DCI_ERR_XALIGN	Rectangle provided was not horizontally aligned on a DWORD boundary	BeginAccess and SetDestination callbacks
DCI_ERR_YALIGN	Rectangle provided was not vertically aligned on a DWORD boundary	BeginAccess and SetDestination callbacks
DCI_ERR_XYALIGN	Rectangle provided was not on a DWORD boundary in both the horizontal and vertical directions	BeginAccess and SetDestination callbacks
DCI_ERR_WIDTHALIGN	Width of rectangle provided is not a DWORD multiple	BeginAccess and SetDestination callbacks
DCI_ERR_HEIGHTALIGN	Height of rectangle provided is not a DWORD multiple	BeginAccess and SetDestination callbacks

1 It is expected that most DCI Providers will allow access to obscured surfaces. It is the responsibility of the provider to handle overlap management for all offscreen and overlay surfaces, even when a surface's destination is totally obscured, through the SetClipList callback. This error code is provided only for use by vendors whose hardware cannot allow access in this case.