View Source

Функция GrdFormatMessage преобразует код ошибки в текстовую строку, соответствующую данному коду.

int GRD_API GrdFormatMessage(	
  HANDLE hGrd,
  int nErrorCode,
  int nLanguage,
  char *szErrorMsg
  int nErrorMsgSize
  void *pReserved
);

hGrd

хэндл, через который будет выполнено преобразование. Если параметр не равен нулю, преобразуется результат функции GrdGetLastError для этого хэндла. Иначе, если этот параметр равен NULL, преобразуется код, указанный в параметре nErrorCode

nErrorCode

код ошибки, который требуется преобразовать. Если hGrd не равен NULL, параметр игнорируется

nLanguage

идентификатор языка. Код ошибки будет преобразован в текстовую строку на языке, идентификатор которого указан

GrdLng_ENG	Язык сообщений английский
GrdLng_RUS	Язык сообщений русский

szErrorMsg

указатель на буфер, в который будет помещена форматированная, заканчивающаяся символом '/0', строка сообщения об ошибке. Память под буфер должна быть выделена до вызова GrdFormatMessage

nErrorMsgSize

максимальное количество символов, которое может содержаться в строке сообщения, считая '/0'в конце строки

pReserved

зарезервировано, параметр игнорируется

Cтандартный набор ошибок

{dojo-tabs:theme=tundra|id=1}
{dojo-tab:title=C|selected=true}
*C*
int GRD_API GrdFormatMessage(	
  HANDLE hGrd,
  int nErrorCode,
  int nLanguage,
  char *szErrorMsg
  int nErrorMsgSize
  void *pReserved
);	
{dojo-tab}
{dojo-tab:title=C#|selected=true}
*C#*

{dojo-tab}
{dojo-tab:title=Visual Basic (Declaration)}
*Visual Basic*

{dojo-tab}
{dojo-tab:title=Visual C++}
*Visual C++*

{dojo-tab}
{dojo-tabs}

hGrd

хэндл, через который будет выполнено преобразование. Если параметр не равен нулю, преобразуется результат функции GrdGetLastError для этого хэндла. Иначе, если этот параметр равен NULL, преобразуется код, указанный в параметре nErrorCode

nErrorCode

код ошибки, который требуется преобразовать. Если hGrd не равен NULL, параметр игнорируется

nLanguage

идентификатор языка. Код ошибки будет преобразован в текстовую строку на языке, идентификатор которого указан

GrdLng_ENG	Язык сообщений английский
GrdLng_RUS	Язык сообщений русский

szErrorMsg

указатель на буфер, в который будет помещена форматированная, заканчивающаяся символом '/0', строка сообщения об ошибке. Память под буфер должна быть выделена до вызова GrdFormatMessage

nErrorMsgSize

максимальное количество символов, которое может содержаться в строке сообщения, считая '/0'в конце строки

pReserved

зарезервировано, параметр игнорируется

Cтандартный набор ошибок

Функция GrdFormatMessage используется для удобства диагностики в пользовательских приложениях. Она преобразует код ошибки nErrorCode или полученный из хэндла, указанного в параметре hGrd, в текстовую строку, содержащую диагностическое сообщение на языке, заданном в параметре nLanguage.

Пример для используемого средства разработки см. в директории:

"\%Program Files%\Guardant\Guardant 6\%PublicCode%\Samples\x86\Win32\General Guardant API\"
или
"\%Program Files%\Guardant\Guardant 6\%Public Code%\Samples\x64\Win64\General Guardant API\"