HFSS15: GetMessageStringToRegisterForSigTerm

Purpose

Obsolete. The string copied to the buffer should be an empty string.

Signature

extern "C" bool FN_PREFIX_GetMessageStringToRegisterForSigTerm (char * buffer, unsigned int* length);

Arguments

buffer: Pointer to a character buffer to contain the string or NULL.

length: Pointer to a location to contain the length of the buffer. Must be a valid pointer to an unsigned int.

Return Value

If argument buffer is NULL, then then required length of the buffer is stored in the location to which argument length points, and true is returned.

If argument buffer is not NULL, then the value to which argument length points (the buffer length) is checked. If it is large enough to contain the string, including the terminal null byte, then the string is copied to the buffer and true is returned. If the buffer length is insufficient for the string, then the buffer is unchanged, and false is returned.

Notes

To get the string, the infrastructure first calls this function with a NULL buffer, and obtains the required length of the buffer for the string. After creating a buffer of the appropriate size, the infrastructure calls this function again, passing the pointer to the buffer in the buffer argument and a pointer to the size of the buffer in the length argument.