Manual Pages for UNIX Operating System command usage for man Tspi_Context_GetRegisteredKeysByUUID2

Introduction to Library Functions
                         Tspi_Context_GetRegisteredKeysByUUID2(3)



NAME
     Tspi_Context_GetRegisteredKeysByUUID2  -  get  an  array  of
     TSS_KM_KEYINFO2  structures based on the state of persistent
     storage.

SYNOPSIS
     #include 
     #include 
     #include 
     #include 
     #include 
     #include 
     #include 

     TSS_RESULT Tspi_Context_GetRegisteredKeysByUUID2(TSS_HCONTEXT     hContext,  TSS_FLAG persistentStorageType,
                                                     TSS_UUID*        pUuidData, UINT32*  pulKeyHierarchySize,
                                                     TSS_KM_KEYINFO2** ppKeyHierarchy);



DESCRIPTION
     TSS_Context_GetRegisteredKeysByUUID2   gets  an   array   of
     TSS_KM_KEYINFO2  structures.  This  information reflects the
     state of the registered key hierarchy. The  keys  stored  in
     the  persistent storage are totallly independent from either
     the context provided in the function call  or  the  context,
     which was provided while processing the key registration.

PARAMETERS
  hContext
     The handle of the context object.

  persistentStorageType
     Flag indicating the persistent storage the key is registered
     in.

  pUuidData
     The UUID the key was registered in  the  persistent  storage
     (TSP  or  connected  TCS).  If no key UUID is provided, thus
     KeyUUID is NULL, the returned array of  the  TSS_KM_KEYINFO2
     structure  contains  data reflecting the whole key hierarchy
     starting with root key. If a certain key is UUID is  provid-
     ed,  the  returned  array of TSS_KM_KEYINFO2 structures only
     contains data reflecting the path of the key  hierarchy  re-
     garding that key. The first array entry is the key addressed
     by the given UUID followed by its parent key up to the  root
     key.

  pulKeyHierarchySize
     Recieves  the  length  (number  of  array  entries)  of  the
     ppKeyHierarchy parameter.



TSS 1.2              Last change: 2007-07-06                    1






Introduction to Library Functions
                         Tspi_Context_GetRegisteredKeysByUUID2(3)



  ppKeyHierarchy
     On successful completion  of  the  command,  this  parameter
     points to a buffer containing the actual key hierarchy data.

RETURN CODES
     Tspi_Context_GetRegisteredKeysByUUID2 returns TSS_SUCCESS on
     success, otherwise one of the following values are returned:

     TSS_E_INVALID_HANDLE - hContext is an invalid

     TSS_E_BAD_PARAMETER

     TSS_E_INTERNAL_ERROR
          An error occurred internal to the TSS.

CONFORMING TO
     Tspi_Context_GetRegisteredKeysByUUID2 conforms to the Trust-
     ed Computing Group Software Specification version 1.2

SEE ALSO
     Tspi_Context_LoadKeyByUUID(3).

ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     __________________________________________________
    |   ATTRIBUTE TYPE   |       ATTRIBUTE VALUE      |
    |____________________|_____________________________|_
    | Availability       |  library/security/trousers |
    |____________________|_____________________________|_
    | Interface Stability|  Uncommitted               |
    |____________________|____________________________|

NOTES
     Source for trousers is available  at  http://opensolaris.org
     and at http://sourceforge.net/projects/trousers.  Documenta-
     tion   is   available    at    file:///usr/share/man,    and
     http://sourceforge.net/projects/trousers.















TSS 1.2              Last change: 2007-07-06                    2






Introduction to Library Functions
                         Tspi_Context_GetRegisteredKeysByUUID2(3)






















































TSS 1.2              Last change: 2007-07-06                    3