Files
@ d6b9b2ac5869
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public-bincomp/vmkernel64/release/lib/vmkapi_name.h
d6b9b2ac5869
3.4 KiB
text/x-chdr
ESXi-5.5-U2
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | /* **********************************************************
* Copyright 2010 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* Name */ /**
* \addtogroup Lib
* @{
* \defgroup Name Names for kernel objects.
*
* @{
***********************************************************************
*/
#ifndef _VMKAPI_NAME_H_
#define _VMKAPI_NAME_H_
/** \cond never */
#ifndef VMK_HEADER_INCLUDED_FROM_VMKAPI_H
#error This vmkapi file should never be included directly but only via vmkapi.h
#endif
/** \endcond never */
/**
* \brief Maximum length for the name of varous kernel objects.
*/
#define VMK_MISC_NAME_MAX 32
/**
* \brief Name of a kernel object.
*
* The name must be NUL-terminated.
*/
typedef struct vmk_Name {
char string[VMK_MISC_NAME_MAX];
} vmk_Name;
/*
***********************************************************************
* vmk_NameInitialize -- */ /**
*
* \brief Initialize a vmk_Name from a string literal.
*
* \note This function will not block.
*
* \param[out] name Name to be used for a kernel object.
* \param[in] string String to initialize name to.
*
* \retval VMK_OK The name was successfully initialized.
* \retval VMK_LIMIT_EXCEEDED string was too long to fit in name.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NameInitialize(vmk_Name *name, const char *string);
/*
***********************************************************************
* vmk_NameFormat -- */ /**
*
* \brief Creates a name from a format string and arguments.
*
* \note This function will not block.
*
* \printformatstringdoc
*
* \param[out] name Name to receive output.
* \param[in] format Format string
*
* \retval VMK_OK The name was successfully formatted.
* \retval VMK_LIMIT_EXCEEDED The resulting name was too long.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_NameFormat(vmk_Name *name, const char *format, ...)
VMK_ATTRIBUTE_PRINTF(2, 3);
/*
***********************************************************************
* vmk_NameToString -- */ /**
*
* \brief Returns a pointer to the string for a name.
*
* \note This function will not block.
*
* \param[in] name Name to convert.
*
* \retval A string for the name.
*
***********************************************************************
*/
const char * vmk_NameToString(const vmk_Name *name);
/*
***********************************************************************
* vmk_NameCopy -- */ /**
*
* \brief Copies a source name to a destination name.
*
* \note This function will not block.
*
* src is copied to dst. No error checking is performed, so if
* src is an invalid name, dst will also be an invalid name.
*
* \param[out] dst Copy destination.
* \param[in] src Name to copy.
*
***********************************************************************
*/
void vmk_NameCopy(vmk_Name *dst, vmk_Name *src);
#endif /* _VMKAPI_TYPES_H_ */
/** @} */
/** @} */
|