String Registration

NVTX_DECLSPEC nvtxStringHandle_t NVTX_API	nvtxDomainRegisterStringA (nvtxDomainHandle_t domain, const char *string)
	Register a string.
NVTX_DECLSPEC nvtxStringHandle_t NVTX_API	nvtxDomainRegisterStringW (nvtxDomainHandle_t domain, const wchar_t *string)

Detailed Description

Registered strings are intended to increase performance by lowering instrumentation overhead. String may be registered once and the handle may be passed in place of a string where an the APIs may allow.

See String Registration for more details

Function Documentation

nvtxDomainRegisterStringA()

NVTX_DECLSPEC nvtxStringHandle_t NVTX_API nvtxDomainRegisterStringA	(	nvtxDomainHandle_t	domain,
		const char *	string
	)

Register a string.

Registers an immutable string with NVTX. Once registered the pointer used to register the domain name can be used in nvtxEventAttributes_t MESSAGE_FIELD. This allows NVTX implementation to skip copying the contents of the message on each event invocation.

String registration is an optimization. It is recommended to use string registration if the string will be passed to an event many times.

String are not unregistered, except that by unregistering the entire domain

Parameters

domain	- Domain handle. If NULL then the global domain is used.
string	- A unique pointer to a sequence of characters.

Returns

A handle representing the registered string.

Example

Register a string:

nvtxDomainHandle_t domain = nvtxDomainCreateA("com.nvidia.nvtx.example");
nvtxStringHandle_t message = nvtxDomainRegisterStringA(domain, "registered string");
nvtxEventAttributes_t eventAttrib = {0};
eventAttrib.version = NVTX_VERSION;
eventAttrib.size = NVTX_EVENT_ATTRIB_STRUCT_SIZE;
eventAttrib.messageType = NVTX_MESSAGE_TYPE_REGISTERED;
eventAttrib.message.registered = message;

Version

NVTX_VERSION_2