xpxGetInstanceContainers

FUNCTION xpxGetInstanceContainers(currInst               : GENERIC;
                                  options                : INTEGER; 
                                  VAR containerId        : GENERIC;
                                  VAR numberOfContainers : INTEGER;
                                  VAR containers         : SET OF GENERIC) 
                                  status                 : INTEGER;

The xpxGetInstanceContainers function returns a buffer with containerIds of all the instance containers of given type in which a given instanceId is contained.

Arguments

Type	Name	Comment
GENERIC	currInst	A numeric instanceID that uniquely identifies the instance of interest in the EDMdatabase.
INTEGER	options	Specifies what type of instance containers to search for. The option value may be a bitwise OR of any combination of the options listed below. If this parameter is unset, the default behaviour is that the <containerId> parameter will receive the id of any lockable container in which the instance is located.
GENERIC	containerId	Variable that will receive the the Id of the lockable container in which the instance Id is located. No instance may be contained by more than one lockable instance container at the same time. Hence, only a single container Id may result when searching for lockable containers. If the instance is not located in any lockable containers, this parameter will be unset.
INTEGER	numberOfContainers	The total number of instance container ids returned in the <containerIds> buffer.
SET OF GENERIC	containers	Variable that will receive a pointer to a buffer of container ids in which the instance given in <currInst> is located. When searching for lockable containers, the id of the container will be returned in this buffer as well as in the parameter <containerId>

Return Value

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

Options

Option	Comment
XPXCONTAINER	Search for all plain instance containers.
XPXLOCK_CONTAINER	Search for any lockable instance container.
XPXMODEL_CONTAINER	Search for all plain instance model containers.
XPXMODEL_LOCK_CONTAINER	Search for any lockable instance model container.

Example

<Missing Example>

EDMsix

xpxGetInstanceContainers

Arguments

Return Value

Options

Example

See also

Filter by label