This structure is used to describe the attributes of a user defined synchronization object. The layout of the structure is defined by a specific version of the tools extension library and can change between different versions of the Tools Extension library.

Initializing the Attributes

The caller should always perform the following three tasks when using attributes:

• Zero the structure

• Set the version field

• Set the size field

Zeroing the structure sets all the event attributes types and values to the default value.

The version and size field are used by the Tools Extension implementation to handle multiple versions of the attributes structure.

It is recommended that the caller use one of the following to methods to initialize the event attributes structure:

Method 1: Initializing nvtxEventAttributes for future compatibility

‎ nvtxSyncUserAttributes_t attribs = {0};
       attribs.version = NVTX_VERSION;
       attribs.size = NVTX_SYNCUSER_ATTRIB_STRUCT_SIZE;

Method 2: Initializing nvtxSyncUserAttributes_t for a specific version

‎ nvtxSyncUserAttributes_t attribs = {0};
       attribs.version = 1;
       attribs.size = (uint16_t)(sizeof(nvtxSyncUserAttributes_t));

If the caller uses Method 1 it is critical that the entire binary layout of the structure be configured to 0 so that all fields are initialized to the default value.

The caller should either use both NVTX_VERSION and NVTX_SYNCUSER_ATTRIB_STRUCT_SIZE (Method 1) or use explicit values and a versioned type (Method 2). Using a mix of the two methods will likely cause either source level incompatibility or binary incompatibility in the future.

Settings Attribute Types and Values

Example:

‎ // Initialize
       nvtxSyncUserAttributes_t attribs = {0};
       attribs.version = NVTX_VERSION;
       attribs.size = NVTX_SYNCUSER_ATTRIB_STRUCT_SIZE;
      
       // Configure the Attributes
       attribs.messageType = NVTX_MESSAGE_TYPE_ASCII;
       attribs.message.ascii = "Example";

See also:

nvtxDomainSyncUserCreate