ACAPI_Attribute_SetUserData
사용자 데이터를 속성에 부착하거나, 부착한 데이터를 제거합니다.
GSErrCode ACAPI_Attribute_SetUserData ( API_Attr_Head* attrHead, const API_AttributeUserData* userData );
파라미터
- attrHead
- [in] 사용자 데이터를 부착할 속성입니다. 헤더의
typeID
와index
필드로 정의됩니다. - userData
- [in] 저장할 사용자 데이터입니다. 만약
dataHdl
이NULL
이면, 이 함수는 사용자 데이터를 제거합니다.
리턴 값
NoError
- 함수가 성공적으로 완료되었습니다.
APIERR_BADPARS
NULL
attrHead
또는userData
포인터가 전달되었습니다.APIERR_BADPLATFORMSIGN
- 사용자 데이터의 플랫폼 기호가 유효하지 않습니다. (범위 밖)
다른 공통 API 오류들에 대해서는 API 오류 문서를 보십시오.
설명
이 함수는 속성에 사용자 데이터를 부착하거나, (만약 userData->dataHdl
이 NULL
일 경우) 부착한 정보를 제거하는 데 사용합니다.
호출자는 userData->dataHdl
을 할당하고 제거할 책임이 있습니다.
이것은 내부 데이터베이스로 복사되기 때문에 사용 후에 전달된 핸들을 안전하게 파괴할 수 있습니다.
요구사항
- 버전: API 4.1 또는 이후
- 헤더: ACAPinc.h
참고사항
API_Attr_Head, API_AttributeUserData,
ACAPI_Attribute_GetUserData,
속성 관리자, API 함수