PvGetError()
Returns an error description string, describing the preceding error. This function is only for errors encountered in catalog functions.
Header File: ddf.h (See also
Header Files)
Function First Available In Library: w3dbav75.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (macOS) (See also
Link Libraries)
Syntax
PRESULT PvGetError(
LPSTR errorDesc,
WORD* size);
Arguments
In/Out | errorDesc | String that will contain the error description. |
In/Out | size | Size of errorDesc. If the size is not large enough to contain the error description, an error is returned and the required size is contained in size. |
Return Values
PCM_Success | The operation was successful. |
PCM_errStringTooShort | The size parameter was not large enough to contain the error description. The required length is returned in the size argument. |
Remarks
The errorDesc string is allocated by the caller.
The maximum size of the error description is specified in the constant ERROR_LEN found in the header file ddf.h.
See Also