hu_YieldCreate()

Creates a yield context object with the given callback function and data.

Synopsis:

#include "huyield.h"

int hu_YieldCreate(hu_YieldFunc *yieldFunc, void *yieldData, sb_YieldCtx *yieldCtx, sb_GlobalCtx sbCtx)

Since:

BlackBerry 10.0.0

Arguments:

yieldFunc: User-provided callback function.

yieldData: User-defined data that will be passed to yieldFunc. (Optional - set to NULL if not required.)

yieldCtx: Yield context object pointer.

sbCtx: Global context.

Library:

libhuapi (For the qcc command, use the -l huapi option to link against this library)

Description:

Returns:

SB_ERR_NULL_CONTEXT_PTR: Context object pointer is NULL.

SB_ERR_NULL_INPUT: Yield function is NULL.

SB_FAIL_ALLOC: Memory allocation failure.

SB_SUCCESS: Success.