GetCaptureCommentFromFilename function

The GetCaptureCommentFromFilename function extracts the capture comment from a capture file.

Syntax

DWORD  WINAPI GetCaptureCommentFromFilename(
  _In_ LPSTR lpFilename,
  _In_ LPSTR lpComment,
  _In_ DWORD BufferSize
);

Parameters

lpFilename [in]

Pointer to the name of the capture file.

lpComment [in]

Pointer to a pre-allocated string for the comment.

BufferSize [in]

Size of the string.

Return value

If the function is successful (that is, if the comment is found and copied, or there is no comment in the capture file), the return value is NMERR_SUCCESS.

If the function is unsuccessful, the return value is an error code.

Return code	Description
NMERR_FILE_READ_ERROR	The capture comment cannot be read.
NMERR_INVALID_FILE_FORMAT	The Comment frame is not a valid file format.
NMERR_FILE_NOT_FOUND	The file specified by the lpFilename parameter cannot be found.
NMERR_INVALID_PARAMETER	One of the parameters is specified incorrectly.

Remarks

Experts and parsers can call the GetCaptureCommentFromFilename function.

To retrieve the comment of a real-time capture, call the GetCaptureComment function.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Netmon.h
Library	Nmapi.lib
DLL	Nmapi.dll

See also

GetCaptureComment