Method ITcComObject:TcGetObjPara

The method TcGetObjPara retrieves a object parameter identified by its PTCID.

Syntax


HRESULT TcGetObjPara(PTCID pid, ULONG& nData, PVOID& pData, PTCGP pgp=0)

Parameter

pid: (type: PTCID) parameter ID of the object parameter.

nData: (type: ULONG&) max. length of the data.

pData: (type: PVOID&) pointer to the data.

pgp: (type: PTCGP) reserved for future extension, NULL forwarded.

Return value

If successful, S_OK ("0") or another positive value will be returned, cf. Return values. Extended messages refer in particular to the column HRESULT in ADS Return Codes.

Description

The method TcGetObjPara retrieves a object parameter identified by its PTCID.