SMC_GetObj (FUN)

 

FUNCTION SMC_GetObj : POINTER TO SMC_GEOINFO

Returns the n-th object of an SMC_OUTQUEUE. For N=0 the first element will be returned. If the number of elements is less than n+1, zero is returned.

Note

This function should only be used from the task that is reading and deleting elements from the queue. If calling from the task appending to the queue, use SMC_GetObjFromEnd instead.

InOut:

Scope

Name

Type

Comment

Input

poq

POINTER TO SMC_OUTQUEUE

The out queue

N

UINT

Index of object in the queue. Counting is started with N=0 for the first element.

Return

SMC_GetObj

POINTER TO SMC_GEOINFO