VxWorks Reference Manual : Libraries

smNameShow

NAME

smNameShow - shared memory objects name database show routines (VxMP Option)

ROUTINES

smNameShow( ) - show the contents of the shared memory objects name database (VxMP Option)

DESCRIPTION

This library provides a routine to show the contents of the shared memory objects name database. The shared memory objects name database facility is provided by smNameLib.

CONFIGURATION

The routines in this library are included by default if INCLUDE_SM_OBJ is defined in configAll.h.

AVAILABILITY

This module is distributed as a component of the unbundled shared memory objects support option, VxMP.

INCLUDE FILES

smNameLib.h

SEE ALSO

smNameShow, smNameLib, smObjLib, VxWorks Programmer's Guide: Shared Memory Objects

---

Libraries : Routines

smNameShow( )

NAME

smNameShow( ) - show the contents of the shared memory objects name database (VxMP Option)

SYNOPSIS

STATUS smNameShow
    (
    int level /* information level */
    )

DESCRIPTION

This routine displays the names, values, and types of objects stored in the shared memory objects name database. Predefined types are shown, using their ASCII representations; all other types are printed in hexadecimal.

The level parameter defines the level of database information displayed. If level is 0, only statistics on the database contents are displayed. If level is greater than 0, then both statistics and database contents are displayed.

WARNING

This routine locks access to the shared memory objects name database while displaying its contents. This can compromise the access time to the name database from other CPUs in the system. Generally, this routine is used for debugging purposes only.

EXAMPLE

-> smNameShow

Names in Database  Max : 30  Current : 6  Free : 24


-> smNameShow 1

Names in Database  Max : 30  Current : 6  Free : 24

Name                Value         Type
---------------- ----------- -------------
inputImage        0x802340    SM_MEM_BLOCK
ouputImage        0x806340    SM_MEM_BLOCK
imagePool         0x802001    SM_MEM_PART
imageInSem        0x8e0001    SM_SEM_B
imageOutSem       0x8e0101    SM_SEM_C
actionQ           0x8e0201    SM_MSG_Q
userObject        0x8e0400    0x1b0

AVAILABILITY

This routine is distributed as a component of the unbundled shared memory objects support option, VxMP.

RETURNS

OK, or ERROR if the name facility is not initialized.

ERRNO

 S_smNameLib_NOT_INITIALIZED 
 S_smObjLib_LOCK_TIMEOUT

SEE ALSO

smNameShow, smNameLib