Parameters for FSEG_FUNC_NEW. More...

#include <FSEG.h>

Data Fields
unsigned int	uiNamLen
	[INPUT] Byte length of pcNamStr (without null).
unsigned int	uiParLen
	[INPUT] Byte length of pcParStr (without null). Paired with uiNamLen so that both pointers start on 8-byte boundaries (alignment rule).
const char *	pcNamStr
	[INPUT] Archive namespace string (null-terminated). The provider must copy this string; the pointer is only valid for the duration of this call.
const char *	pcParStr
	[INPUT] Provider-specific parameter string (null-terminated). Same lifetime constraint as pcNamStr.

Detailed Description

Parameters for FSEG_FUNC_NEW.

The bridge passes the archive namespace and provider parameter string so the provider can copy them into its handle for use in subsequent FSEG_FUNC_OPN, FSEG_FUNC_DAR, FSEG_FUNC_PRN, and FSEG_FUNC_EXS calls. No storage I/O takes place.

On entry *ppHdl is NULL. The provider must allocate its handle and write the pointer to *ppHdl.

Field Documentation

◆ pcNamStr

const char* FsegNew::pcNamStr

[INPUT] Archive namespace string (null-terminated). The provider must copy this string; the pointer is only valid for the duration of this call.

◆ pcParStr

const char* FsegNew::pcParStr

[INPUT] Provider-specific parameter string (null-terminated). Same lifetime constraint as pcNamStr.

◆ uiNamLen

unsigned int FsegNew::uiNamLen

[INPUT] Byte length of pcNamStr (without null).

◆ uiParLen

unsigned int FsegNew::uiParLen

[INPUT] Byte length of pcParStr (without null). Paired with uiNamLen so that both pointers start on 8-byte boundaries (alignment rule).

The documentation for this struct was generated from the following file:

FSEG.h