GetDescription

void GetDescription(long index, char *description, long maxDescriptionLengthInBytes, TSERROR *errorCode, char *errorMsg, long maxErrorMsgLengthInBytes)

Purpose

Returns the description of the file extension the translator supports. TestStand uses the description in the Open File dialog box.

Parameters

Name Type Description
index long The zero-based index of the translator in the DLL that must process the callback.
description string The description of the file extension the translator supports. The callback must copy a string value to the existing buffer, including the NUL terminating character. Use the maxDescriptionLengthInBytes parameter to determine the size of the buffer.
maxDescriptionLengthInBytes long The maximum number of bytes you can copy to the description parameter.
errorCode TSERROR The error code when an error occurs in the callback.
errorMsg string The error message when an error occurs in the callback. The callback must copy a string value to the existing buffer, including the NUL terminating character. Use the maxErrorMsgLengthInBytes parameter to determine the size of the buffer.
maxErrorMsgLengthInBytes long The maximum number of bytes the DLL can copy to the errorMsg parameter.

See Also

Open File dialog box