tibasMetaspace_DefineSpace()

Defines a user space.

Declaration

tibas_status tibasMetaspace_DefineSpace
(tibasMetaspace metaspace,
tibasSpaceDef   spaceDef)

Parameters

Parameter Description
metaspace A Metaspace object that specifies the metaspace in which to define a user space.
spaceDef Specify a SpaceDef object that contains attributes used to define the space.

Remarks

Use the tibasMetaspace_DefineSpace() function to define a user space in a specified metaspace.

Before you call tibasMetaspaceDefineSpace():

  • Create a space definition by calling the tibasSpaceDefCreate() function.

    The tibasSpaceDefCreate() function returns a SpaceDef object that you use as input to tibasSpaceDef functions that set attributes of the space and to the tibasMetaspace_DefineSpace() function.

  • Specify the fields and attributes for the space using the tibasSpaceDef functions.
    Note: Calling tibasMetaspace_DefineSpace() does not automatically join the space. To join the space, call the tibasMetaspaceGetSpace() function or the tibasMetaspaceGetSpaceEx() function and join the space as a seeder or as a leech.

    If the space definition is different than what is already defined, the function returns TIBAS_SYS_ERROR. If the definition is same as for a previously created space, the function returns TIBAS_OK.